🔗 A financial tool for tracking value accrued for a particular purpose. In the healthcare field, used to track charges for a patient, cost centers, etc.Account(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< Unique identifier used to reference the account. Might or might not be intended for human use (e.g. credit card number).; (xsd)identifier:Identifier>*
< Indicates whether the account is presently used/usable or not. This element is labeled as a modifier because the status contains the codes inactive and entered-in-error that mark the Account as not currently valid. Binding: account-status (required, Indicates whether the account is available to be used.); (xsd)status:code>
< The BillingStatus tracks the lifecycle of the account through the billing process. It indicates how transactions are treated when they are allocated to the account. Binding: account-billing-status (example, Indicates whether the account is available to be used for billing purposes.); (xsd)billingStatus:CodeableConcept>?
< Categorizes the account for reporting and searching purposes. Binding: account-type (example, The usage type of this account, permits categorization of accounts.); (xsd)type:CodeableConcept>?
< Name used for the account when displaying it to humans in reports, etc.; (xsd)name:string>?
[]< Identifies the entity which incurs the expenses. While the immediate recipients of services or goods might be entities related to the subject, the expenses were ultimately incurred by the subject of the Account. Accounts can be applied to non-patients for tracking other non-patient related activities, such as group services (patients not tracked, and costs charged to another body), or might not be allocated.; (xsd)subject:(<Device>
|<HealthcareService>
|<Location>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>)>*
< The date range of services associated with this account. It is possible for transactions to be posted outside the service period, as long as the service was provided within the defined service period.; (xsd)servicePeriod:Period>?
[]< The party(s) that are responsible for covering the payment of this account, and what order should they be applied to the account. Typically. this may be some form of insurance, internal charges, or self-pay.
Local or jurisdictional business rules may determine which coverage covers which types of billable items charged to the account, and in which order.
Where the order is important, a local/jurisdictional extension may be defined to specify the order for the type of charge.; (xsd)coverage:Account.coverage>*
< Indicates the service area, hospital, department, etc. with responsibility for managing the Account.; (xsd)owner:Organization*>?
< Provides additional information about what the account tracks and how it is used.; (xsd)description:markdown>?
[]< The parties responsible for balancing the account if other payment options fall short.; (xsd)guarantor:Account.guarantor>*
[]< When using an account for billing a specific Encounter the set of diagnoses that are relevant for billing are stored here on the account where they are able to be sequenced appropriately prior to processing to produce claim(s).; (xsd)diagnosis:Account.diagnosis>*
[]< When using an account for billing a specific Encounter the set of procedures that are relevant for billing are stored here on the account where they are able to be sequenced appropriately prior to processing to produce claim(s).; (xsd)procedure:Account.procedure>*
[]< Other associated accounts related to this account.; (xsd)relatedAccount:Account.relatedAccount>*
< The default currency for the account. Binding: currencies (required, ); (xsd)currency:CodeableConcept>?
[]< The calculated account balances - these are calculated and processed by the finance system.
The balances with a `term` that is not current are usually generated/updated by an invoicing or similar process.; (xsd)balance:Account.balance>*
< Time the balance amount was calculated. The total(s) are not typically updated using the restful API but more often by back-end processes included in a typical finance system.; (xsd)calculatedAt:instant>?🔗 The calculated account balances - these are calculated and processed by the finance system.
The balances with a `term` that is not current are usually generated/updated by an invoicing or similar process.Account.balance(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Who is expected to pay this part of the balance. Binding: account-aggregate (extensible, Indicates the balance was outstanding at the given age.); (xsd)aggregate:CodeableConcept>?
< The term of the account balances - The balance value is the amount that was outstanding for this age. Binding: account-balance-term (extensible, Indicates the balance was outstanding at the given age.); (xsd)term:CodeableConcept>?
< The amount is only an estimated value - this is likely common for `current` term balances, but not with known terms (that were generated by a backend process).; (xsd)estimate:boolean>?
< The actual balance value calculated for the age defined in the term property.; (xsd)amount:Money>🔗 The party(s) that are responsible for covering the payment of this account, and what order should they be applied to the account. Typically. this may be some form of insurance, internal charges, or self-pay.
Local or jurisdictional business rules may determine which coverage covers which types of billable items charged to the account, and in which order.
Where the order is important, a local/jurisdictional extension may be defined to specify the order for the type of charge.Account.coverage(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The party(s) that contribute to payment (or part of) of the charges applied to this account (including self-pay).
A coverage may only be responsible for specific types of charges, and the sequence of the coverages in the account could be important when processing billing.; (xsd)coverage:Coverage*>
< The priority of the coverage in the context of this account. It is common in some jurisdictions for there to be multiple coverages allocated to an account, and a sequence is required to order the settling of the account (often with insurance claiming).; (xsd)priority:positiveInt>?🔗 When using an account for billing a specific Encounter the set of diagnoses that are relevant for billing are stored here on the account where they are able to be sequenced appropriately prior to processing to produce claim(s).Account.diagnosis(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Ranking of the diagnosis (for each type).; (xsd)sequence:positiveInt>?
< The diagnosis relevant to the account. Binding: condition-code (example, ); (xsd)condition:Condition*>
< Ranking of the diagnosis (for each type).; (xsd)dateOfDiagnosis:dateTime>?
[]< Type that this diagnosis has relevant to the account (e.g. admission, billing, discharge …). Binding: encounter-diagnosis-use (preferred, The type of diagnosis this condition represents.); (xsd)type:CodeableConcept>*
< Was the Diagnosis present on Admission in the related Encounter.; (xsd)onAdmission:boolean>?
[]< The package code can be used to group diagnoses that may be priced or delivered as a single product. Such as DRGs. Binding: (example, Local or Regional package codes, e.g. DRGs); (xsd)packageCode:CodeableConcept>*🔗 The parties responsible for balancing the account if other payment options fall short.Account.guarantor(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The entity who is responsible.; (xsd)party:(<Organization>
|<Patient>
|<RelatedPerson>)>
< A guarantor may be placed on credit hold or otherwise have their role temporarily suspended.; (xsd)onHold:boolean>?
< The timeframe during which the guarantor accepts responsibility for the account.; (xsd)period:Period>?🔗 When using an account for billing a specific Encounter the set of procedures that are relevant for billing are stored here on the account where they are able to be sequenced appropriately prior to processing to produce claim(s).Account.procedure(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Ranking of the procedure (for each type).; (xsd)sequence:positiveInt>?
< The procedure relevant to the account. Binding: procedure-code (example, ); (xsd)code:Procedure*>
< Date of the procedure when using a coded procedure. If using a reference to a procedure, then the date on the procedure should be used.; (xsd)dateOfService:dateTime>?
[]< How this procedure value should be used in charging the account. Binding: (example, Usage for the specific procedure - e.g. billing); (xsd)type:CodeableConcept>*
[]< The package code can be used to group procedures that may be priced or delivered as a single product. Such as DRGs. Binding: (example, Local or Regional package codes, e.g. DRGs); (xsd)packageCode:CodeableConcept>*
[]< Any devices that were associated with the procedure relevant to the account.; (xsd)device:Device*>*🔗 Other associated accounts related to this account.Account.relatedAccount(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Relationship of the associated Account. Binding: account-relationship (example, Indicates the relationship between the accounts); (xsd)relationship:CodeableConcept>?
< Reference to an associated Account.; (xsd)account:Account*>🔗 This resource allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context.ActivityDefinition(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< An absolute URI that is used to identify this activity definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this activity definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the activity definition is stored on different servers. Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.
The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions).
In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.; (xsd)url:uri>?
[]< A formal identifier that is used to identify this activity definition when it is represented in other formats, or referenced in a specification, model, design or an instance. Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this activity definition outside of FHIR, where it is not possible to use the logical URI.; (xsd)identifier:Identifier>*
< The identifier that is used to identify this version of the activity definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the activity definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active assets. There may be different activity definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the activity definition with the format [url]|[version]. The version SHOULD NOT contain a '#' - see [Business Version](resource.html#bv-format).; (xsd)version:string>?
< Indicates the mechanism used to compare versions to determine which is more current. If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined. Binding: version-algorithm (extensible, ); (xsd)versionAlgorithm:(<Coding>
|<string>)>?
< A natural language name identifying the activity definition. This name should be usable as an identifier for the module by machine processing applications such as code generation. The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.; (xsd)name:string>?
< A short, descriptive, user-friendly title for the activity definition. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.; (xsd)title:string>?
< An explanatory or alternate title for the activity definition giving additional information about its content.; (xsd)subtitle:string>?
< The status of this activity definition. Enables tracking the life-cycle of the content. Allows filtering of activity definitions that are appropriate for use versus not.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization). Binding: publication-status (required, The lifecycle status of an artifact.); (xsd)status:code>
< A Boolean value to indicate that this activity definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. Allows filtering of activity definitions that are appropriate for use versus not.; (xsd)experimental:boolean>?
< A code, group definition, or canonical reference that describes or identifies the intended subject of the activity being defined. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource. Note that the choice of canonical for the subject element was introduced in R4B to support pharmaceutical quality use cases. To ensure as much backwards-compatibility as possible, it is recommended to only use the new canonical type with these use cases. Binding: participant-resource-types (extensible, The possible types of subjects for an activity (E.g. Patient, Practitioner, Organization, Location, etc.).); (xsd)subject:(<AdministrableProductDefinition>
|<CodeableConcept>
|<EvidenceVariable>
|<Group>
|<ManufacturedItemDefinition>
|<MedicinalProductDefinition>
|<PackagedProductDefinition>
|<SubstanceDefinition>)>?
< The date (and optionally time) when the activity definition was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the activity definition changes. The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the activity definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)date:dateTime>?
< The name of the organization or individual responsible for the release and ongoing maintenance of the activity definition. Usually an organization but may be an individual. The publisher (or steward) of the activity definition is the organization or individual primarily responsible for the maintenance and upkeep of the activity definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the activity definition. This item SHOULD be populated unless the information is available from context.; (xsd)publisher:string>?
[]< Contact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)contact:ContactDetail>*
< A free text natural language description of the activity definition from a consumer's perspective. This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the activity definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the activity definition is presumed to be the predominant language in the place the activity definition was created).; (xsd)description:markdown>?
[]< The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate activity definition instances. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.; (xsd)useContext:UsageContext>*
[]< A legal or geographic region in which the activity definition is intended to be used. It may be possible for the activity definition to be used in jurisdictions other than those for which it was originally designed or intended.
DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.) Binding: jurisdiction (extensible, Countries and regions within which this artifact is targeted for use.); (xsd)jurisdiction:CodeableConcept>*
< Explanation of why this activity definition is needed and why it has been designed as it has. This element does not describe the usage of the activity definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this activity definition.; (xsd)purpose:markdown>?
< A detailed description of how the activity definition is used from a clinical perspective.; (xsd)usage:markdown>?
< A copyright statement relating to the activity definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the activity definition. The short copyright declaration (e.g. (c) '2015+ xyz organization' should be sent in the copyrightLabel element.; (xsd)copyright:markdown>?
< A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved'). The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.; (xsd)copyrightLabel:string>?
< The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)approvalDate:date>?
< The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. If specified, this date follows the original approval date.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)lastReviewDate:date>?
< The period during which the activity definition content was or is planned to be in active use. The effective period for an activity definition determines when the content is applicable for usage and is independent of publication and review dates. For example, a activity intended to be used for the year 2016 might be published in 2015.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)effectivePeriod:Period>?
[]< Descriptive topics related to the content of the activity. Topics provide a high-level categorization of the activity that can be useful for filtering and searching. DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'topic' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#topic and useContext.valueCodeableConcept indicating the topic) Binding: definition-topic (example, High-level categorization of the definition, used for searching, sorting, and filtering.); (xsd)topic:CodeableConcept>*
[]< An individiual or organization primarily involved in the creation and maintenance of the content.; (xsd)author:ContactDetail>*
[]< An individual or organization primarily responsible for internal coherence of the content.; (xsd)editor:ContactDetail>*
[]< An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the content. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)reviewer:ContactDetail>*
[]< An individual or organization asserted by the publisher to be responsible for officially endorsing the content for use in some setting. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)endorser:ContactDetail>*
[]< Related artifacts such as additional documentation, justification, or bibliographic references. Each related artifact is either an attachment, or a reference to another resource, but not both.; (xsd)relatedArtifact:RelatedArtifact>*
[]< A reference to a Library resource containing any formal logic used by the activity definition.; (xsd)library:Library*>*
< A description of the kind of resource the activity definition is representing. For example, a MedicationRequest, a ServiceRequest, or a CommunicationRequest. The kind element may only specify Request resource types to facilitate considering user input as part of processing the result of any automated clinical reasoning processes. To support creation of event resources, such as Observations, RiskAssessments, and DetectedIssues, use a Task resource with the focus of the task set to the event resource to be created. Note that the kind of resource to be created may determine what types of extensions are permitted. Binding: request-resource-types (required, The kind of activity the definition is describing.); (xsd)kind:code>?
< A profile to which the target of the activity definition is expected to conform.; (xsd)profile:StructureDefinition*>?
< Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter. Tends to be less relevant for activities involving particular products. Binding: procedure-code (example, Detailed type of the activity; e.g. CBC.); (xsd)code:CodeableConcept>?
< Indicates the level of authority/intentionality associated with the activity and where the request should fit into the workflow chain. Binding: request-intent (required, Codes indicating the degree of authority/intentionality associated with a request.); (xsd)intent:code>?
< Indicates how quickly the activity should be addressed with respect to other requests. Binding: request-priority (required, Identifies the level of importance to be assigned to actioning the request.); (xsd)priority:code>?
< Set this to true if the definition is to indicate that a particular activity should NOT be performed. If true, this element should be interpreted to reinforce a negative coding. For example NPO as a code with a doNotPerform of true would still indicate to NOT perform the action. This element is not intended to be used to communicate a decision support response to cancel an order in progress. That should be done with the "remove" type of a PlanDefinition or RequestOrchestration.; (xsd)doNotPerform:boolean>?
< The timing or frequency upon which the described activity is to occur. The intent of the timing element is to provide timing when the action should be performed. As a definitional resource, this timing is interpreted as part of an apply operation so that the timing of the result actions in a CarePlan or RequestOrchestration, for example, would be specified by evaluating the timing definition in the context of the apply and setting the resulting timing on the appropriate elements of the target resource. If the timing is an Age, the activity is expected to be performed when the subject is the given Age. When the timing is a Duration, the activity is expected to be performed within the specified duration from the apply. When the timing is a Range, it may be a range of Ages or Durations, providing a range for the expected timing of the resulting activity. When the timing is a Timing, it is establishing a schedule for the timing of the resulting activity.; (xsd)timing:(<Age>
|<Duration>
|<Range>
|<Timing>)>?
< If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example "pain", "on flare-up", etc. Binding: medication-as-needed-reason (example, A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc.); (xsd)asNeeded:(<boolean>
|<CodeableConcept>)>?
< Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc. May reference a specific clinical location or may just identify a type of location.; (xsd)location:Location*>?
[]< Indicates who should participate in performing the action described.; (xsd)participant:ActivityDefinition.participant>*
< Identifies the food, drug or other product being consumed or supplied in the activity. Binding: medication-codes (example, Code describing the type of substance or medication.); (xsd)product:(<CodeableConcept>
|<Ingredient>
|<Medication>
|<Substance>
|<SubstanceDefinition>)>?
< Identifies the quantity expected to be consumed at once (per dose, per meal, etc.).; (xsd)quantity:SimpleQuantity>?
[]< Provides detailed dosage instructions in the same way that they are described for MedicationRequest resources. If a dosage instruction is used, the definition should not specify timing or quantity.; (xsd)dosage:Dosage>*
[]< Indicates the sites on the subject's body where the procedure should be performed (I.e. the target sites). Only used if not implicit in the code found in ServiceRequest.type. Binding: body-site (example, A code that identifies the anatomical location.); (xsd)bodySite:CodeableConcept>*
[]< Defines specimen requirements for the action to be performed, such as required specimens for a lab test.; (xsd)specimenRequirement:SpecimenDefinition*>*
[]< Defines observation requirements for the action to be performed, such as body weight or surface area.; (xsd)observationRequirement:ObservationDefinition*>*
[]< Defines the observations that are expected to be produced by the action.; (xsd)observationResultRequirement:ObservationDefinition*>*
< A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input. Note that if both a transform and dynamic values are specified, the dynamic values will be applied to the result of the transform.; (xsd)transform:StructureMap*>?
[]< Dynamic values that will be evaluated to produce values for elements of the resulting resource. For example, if the dosage of a medication must be computed based on the patient's weight, a dynamic value would be used to specify an expression that calculated the weight, and the path on the request resource that would contain the result. Dynamic values are applied in the order in which they are defined in the ActivityDefinition. Note that if both a transform and dynamic values are specified, the dynamic values will be applied to the result of the transform.; (xsd)dynamicValue:ActivityDefinition.dynamicValue>*🔗 Dynamic values that will be evaluated to produce values for elements of the resulting resource. For example, if the dosage of a medication must be computed based on the patient's weight, a dynamic value would be used to specify an expression that calculated the weight, and the path on the request resource that would contain the result. Dynamic values are applied in the order in which they are defined in the ActivityDefinition. Note that if both a transform and dynamic values are specified, the dynamic values will be applied to the result of the transform.ActivityDefinition.dynamicValue(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The path to the element to be customized. This is the path on the resource that will hold the result of the calculation defined by the expression. The specified path SHALL be a FHIRPath resolvable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. 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). The path attribute contains a [Simple FHIRPath Subset](fhirpath.html#simple) that allows path traversal, but not calculation.; (xsd)path:string>
< An expression specifying the value of the customized element. The expression may be inlined, or may be a reference to a named expression within a logic library referenced by the library element.; (xsd)expression:Expression>🔗 Indicates who should participate in performing the action described.ActivityDefinition.participant(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The type of participant in the action. Binding: action-participant-type (required, The type of participant in the activity.); (xsd)type:code>?
< The type of participant in the action.; (xsd)typeCanonical:CapabilityStatement*>?
< The type of participant in the action. When this element is a reference, it SHOULD be a reference to a definitional resource (for example, a location type, rather than a specific location).; (xsd)typeReference:(<CareTeam>
|<Device>
|<DeviceDefinition>
|<Endpoint>
|<Group>
|<HealthcareService>
|<Location>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>?
< The role the participant should play in performing the described action. Binding: http://terminology.hl7.org/ValueSet/action-participant-role (example, Defines roles played by participants for the action.); (xsd)role:CodeableConcept>?
< Indicates how the actor will be involved in the action - author, reviewer, witness, etc. Binding: action-participant-function (example, ); (xsd)function:CodeableConcept>?🔗 Describes an actor - a human or an application that plays a role in data exchange, and that may have obligations associated with the role the actor plays.ActorDefinition(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< An absolute URI that is used to identify this actor definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this actor definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the actor definition is stored on different servers. Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.
The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions).
In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.; (xsd)url:uri>?
[]< A formal identifier that is used to identify this actor definition when it is represented in other formats, or referenced in a specification, model, design or an instance.; (xsd)identifier:Identifier>*
< The identifier that is used to identify this version of the actor definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the actor definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. There may be different actor definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the actor definition with the format [url]|[version]. The version SHOULD NOT contain a '#' - see [Business Version](resource.html#bv-format).; (xsd)version:string>?
< Indicates the mechanism used to compare versions to determine which is more current. If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined. Binding: version-algorithm (extensible, ); (xsd)versionAlgorithm:(<Coding>
|<string>)>?
< A natural language name identifying the actor definition. This name should be usable as an identifier for the module by machine processing applications such as code generation. The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.; (xsd)name:string>?
< A short, descriptive, user-friendly title for the actor definition. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.; (xsd)title:string>?
< The status of this actor definition. Enables tracking the life-cycle of the content. Allows filtering of actor definitions that are appropriate for use versus not.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization). Binding: publication-status (required, The lifecycle status of an artifact.); (xsd)status:code>
< A Boolean value to indicate that this actor definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. Allows filtering of actor definitions that are appropriate for use versus not.; (xsd)experimental:boolean>?
< The date (and optionally time) when the actor definition was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the actor definition changes. The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the actor definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)date:dateTime>?
< The name of the organization or individual responsible for the release and ongoing maintenance of the actor definition. Usually an organization but may be an individual. The publisher (or steward) of the actor definition is the organization or individual primarily responsible for the maintenance and upkeep of the actor definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the actor definition. This item SHOULD be populated unless the information is available from context.; (xsd)publisher:string>?
[]< Contact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)contact:ContactDetail>*
< A free text natural language description of the actor. This description can be used for a general description of the actor, and which covers why it was defined.; (xsd)description:markdown>?
[]< The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate actor definition instances. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.; (xsd)useContext:UsageContext>*
[]< A legal or geographic region in which the actor definition is intended to be used. It may be possible for the actor definition to be used in jurisdictions other than those for which it was originally designed or intended.
DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.) Binding: jurisdiction (extensible, Countries and regions within which this artifact is targeted for use.); (xsd)jurisdiction:CodeableConcept>*
< Explanation of why this actor definition is needed and why it has been designed as it has. This element does not describe the usage of the actor definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this actor definition.; (xsd)purpose:markdown>?
< A copyright statement relating to the actor definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the actor definition. ...; (xsd)copyright:markdown>?
< A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved'). The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.; (xsd)copyrightLabel:string>?
< Whether the actor represents a human or an appliction. Binding: examplescenario-actor-type (required, The type of actor - system or human.); (xsd)type:code>
< Documentation about the functionality of the actor. In general terms, the description desribes what the actor is, and this element describes what the actor does (or is expected to do).; (xsd)documentation:markdown>?
[]< A reference to additional documentation about the actor, but description and documentation.; (xsd)reference:url>*
< The capability statement for the actor (if the concept is applicable).; (xsd)capabilities:CapabilityStatement*>?
[]< A url that identifies the definition of this actor in another IG (which IG must be listed in the dependencies). This actor inherits all the obligations etc. as defined in the other IG.; (xsd)derivedFrom:ActorDefinition*>*🔗 Represents a defined collection of entities that may be discussed or acted upon collectively but which are not expected to act collectively, and are not formally or legally recognized; i.e. a collection of entities that isn't an Organization. If both Group.characteristic and Group.member are present, then the members are the individuals who were found who met the characteristic. It's possible that there might be other candidate members who meet the characteristic and aren't (yet) in the list. All members SHALL have the listed characteristics.actualgroup(xsd)(doc)=
<#base:Group>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< Business identifiers assigned to this participant by one of the applications involved. These identifiers remain constant as the resource is updated and propagates from server to server. Note: This is a business identifier, not a resource identifier (see [discussion](resource.html#identifiers)). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types.; (xsd)identifier:Identifier>*
< Indicates whether the record for the group is available for use or is merely being retained for historical purposes.; (xsd)active:boolean>?
< Identifies the broad classification of the kind of resources the group includes. Group members SHALL be of the appropriate resource type (Patient for person or animal; or Practitioner, PractitionerRole, Device, CareTeam, HealthcareService, Location, Organization, RelatedPerson, or Specimen for the other types.), or a Group of the resources of the appropriate type. Binding: group-type (required, Types of resources that are part of group.); (xsd)type:code>
< Basis for membership in the Group:
* 'definitional': The Group.characteristics specified are both necessary and sufficient to determine membership. All entities that meet the criteria are considered to be members of the group, whether referenced by the group or not. If members are present, they are individuals that happen to be known as meeting the Group.characteristics. The list cannot be presumed to be complete.
* 'enumerated': The Group.characteristics are necessary but not sufficient to determine membership. Membership is determined by being listed as one of the Group.member. Binding: group-membership-basis (required, The basis for membership in a group) enumerated; (xsd)membership:code>
< Provides a specific type of resource the group includes; e.g. "cow", "syringe", etc. This would generally be omitted for Person resources. Binding: (example, Kind of particular resource; e.g. cow, syringe, lake, etc.); (xsd)code:CodeableConcept>?
< A label assigned to the group for human identification and communication.; (xsd)name:string>?
< Explanation of what the group represents and how it is intended to be used.; (xsd)description:markdown>?
< A count of the number of resource instances that are part of the group. Note that the quantity may be less than the number of members if some of the members are not active.; (xsd)quantity:unsignedInt>?
< Entity responsible for defining and maintaining Group characteristics and/or registered members. This does not strictly align with ownership of a herd or flock, but may suffice to represent that relationship in simple cases. More complex cases will require an extension.; (xsd)managingEntity:(<Organization>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>?
[]< Identifies traits whose presence r absence is shared by members of the group. All the identified characteristics must be true for an entity to a member of the group.; (xsd)characteristic:actualgroup.characteristic>*
[]< Identifies the resource instances that are members of the group.; (xsd)member:actualgroup.member>*🔗 Identifies traits whose presence r absence is shared by members of the group. All the identified characteristics must be true for an entity to a member of the group.actualgroup.characteristic(xsd)(doc)=
<#base:Group.characteristic>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A code that identifies the kind of trait being asserted. Binding: (example, List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.); (xsd)code:CodeableConcept>
(<valueBoolean:boolean>
|<valueCodeableConcept:CodeableConcept>
|<valueQuantity:Quantity>
|<valueRange:Range>
|<valueResource:Resource>)
< If true, indicates the characteristic is one that is NOT held by members of the group. This is labeled as "Is Modifier" because applications cannot wrongly include excluded members as included or vice versa.; (xsd)exclude:boolean>
< The period over which the characteristic is tested; e.g. the patient had an operation during the month of June.; (xsd)period:Period>?🔗 Identifies the resource instances that are members of the group.actualgroup.member(xsd)(doc)=
<#base:Group.member>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A reference to the entity that is a member of the group. Must be consistent with Group.type. If the entity is another group, then the type must be the same.; (xsd)entity:(<CareTeam>
|<Device>
|<Group>
|<HealthcareService>
|<Location>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>
|<Specimen>)>
< The period that the member was in the group, if known.; (xsd)period:Period>?
< A flag to indicate that the member is no longer in the group, but previously may have been a member.; (xsd)inactive:boolean>?🔗 An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world.
The ISO21090-codedString may be used to provide a coded representation of the contents of strings in an Address. 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(xsd)(doc)=
<#base:DataType>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< The purpose of this address. Applications can assume that an address is current unless it explicitly says that it is temporary or old. Binding: address-use (required, The use of an address (home / work / etc.).); (xsd)use:code>?
< 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). Binding: address-type (required, The type of an address (physical / postal).); (xsd)type:code>?
< 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.; (xsd)text:string>?
[]< This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.; (xsd)line:string>*
< The name of the city, town, suburb, village or other community or delivery center.; (xsd)city:string>?
< 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.; (xsd)district:string>?
< 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).; (xsd)state:string>?
< A postal code designating a region defined by the postal service.; (xsd)postalCode:string>?
< Country - a nation as commonly understood or generally accepted. ISO 3166 2- or 3- letter codes MAY be used in place of a human readable country name.; (xsd)country:string>?
< Time period when address was/is in use.; (xsd)period:Period>?🔗 A medicinal product in the final form which is suitable for administering to a patient (after any mixing of multiple components, dissolution etc. has been performed).AdministrableProductDefinition(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< An identifier for the administrable product.; (xsd)identifier:Identifier>*
< The status of this administrable product. Enables tracking the life-cycle of the content. Allows filtering of administrable products that are appropriate for use versus not. Binding: publication-status (required, The lifecycle status of an artifact.); (xsd)status:code>
[]< References a product from which one or more of the constituent parts of that product can be prepared and used as described by this administrable product. If this administrable product describes the administration of a crushed tablet, the 'formOf' would be the product representing a distribution containing tablets and possibly also a cream. This is distinct from the 'producedFrom' which refers to the specific components of the product that are used in this preparation, rather than the product as a whole.; (xsd)formOf:MedicinalProductDefinition*>*
< The dose form of the final product after necessary reconstitution or processing. Contrasts to the manufactured dose form (see ManufacturedItemDefinition). If the manufactured form was 'powder for solution for injection', the administrable dose form could be 'solution for injection' (once mixed with another item having manufactured form 'solvent for solution for injection'). Binding: administrable-dose-form (example, Dose form for a medication, in the form suitable for administering to the patient, after mixing, where necessary.); (xsd)administrableDoseForm:CodeableConcept>?
< The presentation type in which this item is given to a patient. e.g. for a spray - 'puff' (as in 'contains 100 mcg per puff'), or for a liquid - 'vial' (as in 'contains 5 ml per vial'). Binding: unit-of-presentation (example, The presentation type in which an administrable medicinal product is given to a patient.); (xsd)unitOfPresentation:CodeableConcept>?
[]< Indicates the specific manufactured items that are part of the 'formOf' product that are used in the preparation of this specific administrable form. In some cases, an administrable form might use all of the items from the overall product (or there might only be one item), while in other cases, an administrable form might use only a subset of the items available in the overall product. For example, an administrable form might involve combining a liquid and a powder available as part of an overall product, but not involve applying the also supplied cream.; (xsd)producedFrom:ManufacturedItemDefinition*>*
[]< The ingredients of this administrable medicinal product. This is only needed if the ingredients are not specified either using ManufacturedItemDefiniton (via AdministrableProductDefinition.producedFrom) to state which component items are used to make this, or using by incoming references from the Ingredient resource, to state in detail which substances exist within this. This element allows a basic coded ingredient to be used. Binding: substance-codes (example, This value set includes all substance codes from SNOMED CT - provided as an exemplar value set.); (xsd)ingredient:CodeableConcept>*
< A device that is integral to the medicinal product, in effect being considered as an "ingredient" of the medicinal product. This is not intended for devices that are just co-packaged.; (xsd)device:DeviceDefinition*>?
< A general description of the product, when in its final form, suitable for administration e.g. effervescent blue liquid, to be swallowed. Intended to be used when the other structured properties of this resource are insufficient or cannot be supported. It is not intended to duplicate information already carried elswehere.; (xsd)description:markdown>?
[]< Characteristics e.g. a product's onset of action.; (xsd)property:AdministrableProductDefinition.property>*
[]< The path by which the product is taken into or makes contact with the body. In some regions this is referred to as the licenced or approved route. RouteOfAdministration cannot be used when the 'formOf' product already uses MedicinalProductDefinition.route (and vice versa).; (xsd)routeOfAdministration:AdministrableProductDefinition.routeOfAdministration>+🔗 Characteristics e.g. a product's onset of action.AdministrableProductDefinition.property(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A code expressing the type of characteristic. Binding: product-characteristic-codes (example, This value set includes all observable entity codes from SNOMED CT - provided as an exemplar value set.); (xsd)type:CodeableConcept>
(<valueAttachment:Attachment>
|<valueBinary:Binary>
|<valueBoolean:boolean>
|<valueCodeableConcept:CodeableConcept>
|<valueDate:date>
|<valueMarkdown:markdown>
|<valueQuantity:Quantity>)?
< The status of characteristic e.g. assigned or pending. Binding: publication-status (required, The lifecycle status of an artifact.); (xsd)status:CodeableConcept>?🔗 The path by which the product is taken into or makes contact with the body. In some regions this is referred to as the licenced or approved route. RouteOfAdministration cannot be used when the 'formOf' product already uses MedicinalProductDefinition.route (and vice versa).AdministrableProductDefinition.routeOfAdministration(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Coded expression for the route. Binding: route-codes (example, A code specifying the route or physiological path of administration of a therapeutic agent into or onto a patient's body.); (xsd)code:CodeableConcept>
< The first dose (dose quantity) administered can be specified for the product, using a numerical value and its unit of measurement.; (xsd)firstDose:Quantity>?
< The maximum single dose that can be administered, specified using a numerical value and its unit of measurement.; (xsd)maxSingleDose:Quantity>?
< The maximum dose per day (maximum dose quantity to be administered in any one 24-h period) that can be administered.; (xsd)maxDosePerDay:Quantity>?
< The maximum dose per treatment period that can be administered.; (xsd)maxDosePerTreatmentPeriod:Ratio>?
< The maximum treatment period during which the product can be administered.; (xsd)maxTreatmentPeriod:Duration>?
[]< A species for which this route applies.; (xsd)targetSpecies:AdministrableProductDefinition.routeOfAdministration.targetSpecies>*🔗 A species for which this route applies.AdministrableProductDefinition.routeOfAdministration.targetSpecies(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Coded expression for the species. Binding: target-species (example, A tissue type of an animal.); (xsd)code:CodeableConcept>
[]< A species specific time during which consumption of animal product is not appropriate.; (xsd)withdrawalPeriod:AdministrableProductDefinition.routeOfAdministration.targetSpecies.withdrawalPeriod>*🔗 A species specific time during which consumption of animal product is not appropriate.AdministrableProductDefinition.routeOfAdministration.targetSpecies.withdrawalPeriod(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Coded expression for the type of tissue for which the withdrawal period applies, e.g. meat, milk. Binding: animal-tissue-type (example, A tissue type of an animal.); (xsd)tissue:CodeableConcept>
< A value for the time.; (xsd)value:Quantity>
< Extra information about the withdrawal period.; (xsd)supportingInformation:string>?🔗 An event (i.e. any change to current patient status) that may be related to unintended effects on a patient or research participant. The unintended effects may require additional monitoring, treatment, hospitalization, or may result in death. The AdverseEvent resource also extends to potential or avoided events that could have had such effects. There are two major domains where the AdverseEvent resource is expected to be used. One is in clinical care reported adverse events and the other is in reporting adverse events in clinical research trial management. Adverse events can be reported by healthcare providers, patients, caregivers or by medical products manufacturers. Given the differences between these two concepts, we recommend consulting the domain specific implementation guides when implementing the AdverseEvent Resource. The implementation guides include specific extensions, value sets and constraints.AdverseEvent(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< Business identifiers assigned to this adverse event by the performer or other systems which remain constant as the resource is updated and propagates from server to server. This is a business identifier, not a resource identifier (see [discussion](resource.html#identifiers)). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.; (xsd)identifier:Identifier>*
< The current state of the adverse event or potential adverse event. This is not the reporting of the event to any regulatory or quality organization. This is not the outcome of the patient's condition. Binding: adverse-event-status (required, Codes identifying the lifecycle stage of an event.); (xsd)status:code>
< Whether the event actually happened or was a near miss. Note that this is independent of whether anyone was affected or harmed or how severely. AllergyIntolerance should be used for the initial capture or recording of the individual's propensity to an adverse reaction to a substance. If an AllergyIntolerance does not exist, then an adverse reaction should be recorded as an AllergyIntolerance. If an AllergyIntolerance does exist and the substance was given, then an adverse reaction should be recorded as an AdverseEvent due to the aberrant workflow. Binding: adverse-event-actuality (required, Overall nature of the adverse event, e.g. real or potential.); (xsd)actuality:code>
[]< The overall type of event, intended for search and filtering purposes. Binding: adverse-event-category (example, Overall categorization of the event, e.g. product-related or situational.); (xsd)category:CodeableConcept>*
< Specific event that occurred or that was averted, such as patient fall, wrong organ removed, or wrong blood transfused. Binding: adverse-event-type (example, Detailed type of event.); (xsd)code:CodeableConcept>?
< This subject or group impacted by the event. If AdverseEvent.resultingEffect differs among members of the group, then use Patient as the subject.; (xsd)subject:(<Group>
|<Patient>
|<Practitioner>
|<RelatedPerson>
|<ResearchSubject>)>
< The Encounter associated with the start of the AdverseEvent. This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter. For example, if a medication administration was considered an adverse event because it resulted in a rash, then the encounter when the medication administration was given is the associated encounter. If the patient reports the AdverseEvent during a second encounter, that second encounter is not the associated encounter.; (xsd)encounter:Encounter*>?
< The date (and perhaps time) when the adverse event occurred.; (xsd)occurrence:(<dateTime>
|<Period>
|<Timing>)>?
< Estimated or actual date the AdverseEvent began, in the opinion of the reporter.; (xsd)detected:dateTime>?
< The date on which the existence of the AdverseEvent was first recorded. The recordedDate represents the date when this particular AdverseEvent record was created in the system, not the date of the most recent update. The date of the last record modification can be retrieved from the resource metadata.; (xsd)recordedDate:dateTime>?
[]< Information about the condition that occurred as a result of the adverse event, such as hives due to the exposure to a substance (for example, a drug or a chemical) or a broken leg as a result of the fall.; (xsd)resultingEffect:(<Condition>
|<Observation>)>*
< The information about where the adverse event occurred.; (xsd)location:Location*>?
< Assessment whether this event, or averted event, was of clinical importance. Using an example, a rash can have an AdverseEvent.resultingEffect.severity = severe, yet an AdverseEvent.seriousness = non-serious. Alternatively, a medication given with the wrong dose (chemotherapy given with too low of a dose) can have an AdverseEvent.resultingEffect.severity = mild, yet an adverseEvent.seriousness = serious. Another example would be a beta blocker clinical trial where patients with asthma should be excluded, yet a patient with asthma was included and had an asthmatic episode where AdverseEvent.resultingEffect.severity = mild, yet an adverseEvent.seriousness = serious. Binding: adverse-event-seriousness (example, Overall seriousness of this event for the patient.); (xsd)seriousness:CodeableConcept>?
[]< Describes the type of outcome from the adverse event, such as resolved, recovering, ongoing, resolved-with-sequelae, or fatal. Binding: adverse-event-outcome (example, Codes describing the type of outcome from the adverse event.); (xsd)outcome:CodeableConcept>*
< Information on who recorded the adverse event. May be the patient or a practitioner.; (xsd)recorder:(<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>
|<ResearchSubject>)>?
[]< Indicates who or what participated in the adverse event and how they were involved.; (xsd)participant:AdverseEvent.participant>*
[]< The research study that the subject is enrolled in.; (xsd)study:ResearchStudy*>*
< Considered likely or probable or anticipated in the research study. Whether the reported event matches any of the outcomes for the patient that are considered by the study as known or likely.; (xsd)expectedInResearchStudy:boolean>?
[]< Describes the entity that is suspected to have caused the adverse event.; (xsd)suspectEntity:AdverseEvent.suspectEntity>*
[]< The contributing factors suspected to have increased the probability or severity of the adverse event.; (xsd)contributingFactor:AdverseEvent.contributingFactor>*
[]< Preventive actions that contributed to avoiding the adverse event.; (xsd)preventiveAction:AdverseEvent.preventiveAction>*
[]< The ameliorating action taken after the adverse event occured in order to reduce the extent of harm.; (xsd)mitigatingAction:AdverseEvent.mitigatingAction>*
[]< Supporting information relevant to the event.; (xsd)supportingInfo:AdverseEvent.supportingInfo>*
[]< Comments made about the adverse event by the performer, subject or other participants.; (xsd)note:Annotation>*🔗 The contributing factors suspected to have increased the probability or severity of the adverse event.AdverseEvent.contributingFactor(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The item that is suspected to have increased the probability or severity of the adverse event. Binding: adverse-event-contributing-factor (example, Codes describing the contributing factors suspected to have increased the probability or severity of the adverse event.); (xsd)item:(<AllergyIntolerance>
|<CodeableConcept>
|<Condition>
|<Device>
|<DeviceUsage>
|<DocumentReference>
|<FamilyMemberHistory>
|<Immunization>
|<MedicationAdministration>
|<MedicationStatement>
|<Observation>
|<Procedure>)>🔗 The ameliorating action taken after the adverse event occured in order to reduce the extent of harm.AdverseEvent.mitigatingAction(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The ameliorating action taken after the adverse event occured in order to reduce the extent of harm. Binding: adverse-event-mitigating-action (example, Codes describing the ameliorating actions taken after the adverse event occured in order to reduce the extent of harm.); (xsd)item:(<CodeableConcept>
|<DocumentReference>
|<MedicationAdministration>
|<MedicationRequest>
|<Procedure>)>🔗 Indicates who or what participated in the adverse event and how they were involved.AdverseEvent.participant(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Distinguishes the type of involvement of the actor in the adverse event, such as contributor or informant. Binding: adverse-event-participant-function (example, Codes describing the type of involvement of the actor in the adverse event.); (xsd)function:CodeableConcept>?
< Indicates who or what participated in the event. For example, the physician prescribing a drug, a nurse administering the drug, a device that administered the drug, a witness to the event, or an informant of clinical history.; (xsd)actor:(<CareTeam>
|<Device>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>
|<ResearchSubject>)>🔗 Preventive actions that contributed to avoiding the adverse event.AdverseEvent.preventiveAction(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The action that contributed to avoiding the adverse event. Binding: adverse-event-preventive-action (example, Codes describing the preventive actions that contributed to avoiding the adverse event.); (xsd)item:(<CodeableConcept>
|<DocumentReference>
|<Immunization>
|<MedicationAdministration>
|<MedicationRequest>
|<Procedure>)>🔗 Supporting information relevant to the event.AdverseEvent.supportingInfo(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Relevant past history for the subject. In a clinical care context, an example being a patient had an adverse event following a pencillin administration and the patient had a previously documented penicillin allergy. In a clinical trials context, an example is a bunion or rash that was present prior to the study. Additionally, the supporting item can be a document that is relevant to this instance of the adverse event that is not part of the subject's medical history. For example, a clinical note, staff list, or material safety data sheet (MSDS). Supporting information is not a contributing factor, preventive action, or mitigating action. Binding: adverse-event-supporting-info (example, Codes describing the supporting information relevant to the event.); (xsd)item:(<AllergyIntolerance>
|<CodeableConcept>
|<Condition>
|<DocumentReference>
|<FamilyMemberHistory>
|<Immunization>
|<MedicationAdministration>
|<MedicationStatement>
|<Observation>
|<Procedure>
|<QuestionnaireResponse>)>🔗 Describes the entity that is suspected to have caused the adverse event.AdverseEvent.suspectEntity(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Identifies the actual instance of what caused the adverse event. May be a substance, medication, medication administration, medication statement or a device.; (xsd)instance:(<BiologicallyDerivedProduct>
|<CodeableConcept>
|<Device>
|<Immunization>
|<Medication>
|<MedicationAdministration>
|<MedicationStatement>
|<Procedure>
|<ResearchStudy>
|<Substance>)>
< Information on the possible cause of the event.; (xsd)causality:AdverseEvent.suspectEntity.causality>?🔗 Information on the possible cause of the event.AdverseEvent.suspectEntity.causality(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The method of evaluating the relatedness of the suspected entity to the event. Binding: adverse-event-causality-method (example, TODO.); (xsd)assessmentMethod:CodeableConcept>?
< The result of the assessment regarding the relatedness of the suspected entity to the event. Binding: adverse-event-causality-assess (example, Codes for the assessment of whether the entity caused the event.); (xsd)entityRelatedness:CodeableConcept>?
< The author of the information on the possible cause of the event.; (xsd)author:(<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>
|<ResearchSubject>)>?🔗 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. Binding: age-units (extensible, Appropriate units for Age.)Age(xsd)(doc)=
<#base:Quantity>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< 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).; (xsd)value:decimal>?
< 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. Binding: quantity-comparator (required, How the Quantity should be understood and represented.); (xsd)comparator:code>?
< A human-readable form of the unit.; (xsd)unit:string>?
< The identification of the system that provides the coded form of the unit.; (xsd)system:uri>?
< 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.; (xsd)code>?🔗 Risk of harmful or undesirable physiological response which is specific to an individual and associated with exposure to a substance. Substances include, but are not limited to: a therapeutic substance administered correctly at an appropriate dosage for the individual; food; material derived from plants or animals; or venom from insect stings.AllergyIntolerance(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< Business identifiers assigned to this AllergyIntolerance by the performer or other systems which remain constant as the resource is updated and propagates from server to server. This is a business identifier, not a resource identifier (see [discussion](resource.html#identifiers)). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.; (xsd)identifier:Identifier>*
< The clinical status of the allergy or intolerance. AllergyIntolerance.clinicalStatus should be present if verificationStatus is not entered-in-error and the AllergyIntolerance.code isn't negated (No Known Allergy, No Drug Allergy, No Food Allergy, No Latex Allergy).
Refer to [discussion](extensibility.html#Special-Case) if clinicalStatus is missing data.
The data type is CodeableConcept because clinicalStatus has some clinical judgment involved, such that there might need to be more specificity than the required FHIR value set allows. For example, a SNOMED coding might allow for additional specificity. Binding: allergyintolerance-clinical (required, The clinical status of the allergy or intolerance.); (xsd)clinicalStatus:CodeableConcept>?
< Assertion about certainty associated with the propensity, or potential risk, of a reaction to the identified substance (including pharmaceutical product). The verification status pertains to the allergy or intolerance, itself, not to any specific AllergyIntolerance attribute. The data type is CodeableConcept because verificationStatus has some clinical judgment involved, such that there might need to be more specificity than the required FHIR value set allows. For example, a SNOMED coding might allow for additional specificity. Binding: allergyintolerance-verification (required, Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.); (xsd)verificationStatus:CodeableConcept>?
< Identification of the underlying physiological mechanism for the reaction risk. Allergic (typically immune-mediated) reactions have been traditionally regarded as an indicator for potential escalation to significant future risk. Contemporary knowledge suggests that some reactions previously thought to be immune-mediated are, in fact, non-immune, but in some cases can still pose a life threatening risk. It is acknowledged that many clinicians might not be in a position to distinguish the mechanism of a particular reaction. Often the term "allergy" is used rather generically and may overlap with the use of "intolerance" - in practice the boundaries between these two concepts might not be well-defined or understood. This data element is included nevertheless, because many legacy systems have captured this attribute. Immunologic testing may provide supporting evidence for the basis of the reaction and the causative substance, but no tests are 100% sensitive or specific for sensitivity to a particular substance. If, as is commonly the case, it is unclear whether the reaction is due to an allergy or an intolerance, then the type element should be omitted from the resource. Binding: allergy-intolerance-type (preferred, Identification of the underlying physiological mechanism for a Reaction Risk.); (xsd)type:CodeableConcept>?
[]< Category of the identified substance. This data element has been included because it is currently being captured in some clinical systems. This data can be derived from the substance where coding systems are used, and is effectively redundant in that situation. When searching on category, consider the implications of AllergyIntolerance resources without a category. For example, when searching on category = medication, medication allergies that don't have a category valued will not be returned. Refer to [search](search.html) for more information on how to search category with a :missing modifier to get allergies that don't have a category. Additionally, category should be used with caution because category can be subjective based on the sender. Binding: allergy-intolerance-category (required, Category of an identified substance associated with allergies or intolerances.); (xsd)category:code>*
< Estimate of the potential clinical harm, or seriousness, of the reaction to the identified substance. The default criticality value for any propensity to an adverse reaction should be 'Low Risk', indicating at the very least a relative contraindication to deliberate or voluntary exposure to the substance. 'High Risk' is flagged if the clinician has identified a propensity for a more serious or potentially life-threatening reaction, such as anaphylaxis, and implies an absolute contraindication to deliberate or voluntary exposure to the substance. If this element is missing, the criticality is unknown (though it may be known elsewhere). Systems that capture a severity at the condition level are actually representing the concept of criticality whereas the severity documented at the reaction level is representing the true reaction severity. Existing systems that are capturing both condition criticality and reaction severity may use the term "severity" to represent both. Criticality is the worst it could be in the future (i.e. situation-agnostic) whereas severity is situation-dependent. Binding: allergy-intolerance-criticality (required, Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.); (xsd)criticality:code>?
< Code for an allergy or intolerance statement (either a positive or a negated/excluded statement). This may be a code for a substance or pharmaceutical product that is considered to be responsible for the adverse reaction risk (e.g., "Latex"), an allergy or intolerance condition (e.g., "Latex allergy"), or a negated/excluded code for a specific substance or class (e.g., "No latex allergy") or a general or categorical negated statement (e.g., "No known allergy", "No known drug allergies"). Note: the substance for a specific reaction may be different from the substance identified as the cause of the risk, but it must be consistent with it. For instance, it may be a more specific substance (e.g. a brand medication) or a composite product that includes the identified substance. It must be clinically safe to only process the 'code' and ignore the 'reaction.substance'. If a receiving system is unable to confirm that AllergyIntolerance.reaction.substance falls within the semantic scope of AllergyIntolerance.code, then the receiving system should ignore AllergyIntolerance.reaction.substance. It is strongly recommended that this element be populated using a terminology, where possible. For example, some terminologies used include RxNorm, SNOMED CT, DM+D, NDFRT, ICD-9, IDC-10, UNII, and ATC. Plain text should only be used if there is no appropriate terminology available. Additional details can be specified in the text.
When a substance or product code is specified for the 'code' element, the "default" semantic context is that this is a positive statement of an allergy or intolerance (depending on the value of the 'type' element, if present) condition to the specified substance/product. In the corresponding SNOMED CT allergy model, the specified substance/product is the target (destination) of the "Causative agent" relationship.
The 'substanceExposureRisk' extension is available as a structured and more flexible alternative to the 'code' element for making positive or negative allergy or intolerance statements. This extension provides the capability to make "no known allergy" (or "no risk of adverse reaction") statements regarding any coded substance/product (including cases when a pre-coordinated "no allergy to x" concept for that substance/product does not exist). If the 'substanceExposureRisk' extension is present, the AllergyIntolerance.code element SHALL be omitted. Binding: allergyintolerance-code (example, Type of the substance/product, allergy or intolerance condition, or negation/exclusion codes for reporting no known allergies.); (xsd)code:CodeableConcept>?
< The patient who has the allergy or intolerance.; (xsd)patient:Patient*>
< The encounter when the allergy or intolerance was asserted.; (xsd)encounter:Encounter*>?
< Estimated or actual date, date-time, or age when allergy or intolerance was identified. Age is generally used when the patient reports an age at which the AllergyIntolerance was noted. Period is generally used to convey an imprecise onset that occurred within the time period. Range is generally used to convey an imprecise age range (e.g. 4 to 6 years old).; (xsd)onset:(<Age>
|<dateTime>
|<Period>
|<Range>
|<string>)>?
< The recordedDate represents when this particular AllergyIntolerance record was created in the system, which is often a system-generated date. When onset date is unknown, recordedDate can be used to establish if the allergy or intolerance was present on or before a given date. If the recordedDate is known and provided by a sending system, it is preferred that the receiving system preserve that recordedDate value. If the recordedDate is not provided by the sending system, the receipt timestamp is sometimes used as the recordedDate.; (xsd)recordedDate:dateTime>?
[]< Indicates who or what participated in the activities related to the allergy or intolerance and how they were involved.; (xsd)participant:AllergyIntolerance.participant>*
< Represents the date and/or time of the last known occurrence of a reaction event. This date may be replicated by one of the Onset of Reaction dates. Where a textual representation of the date of last occurrence is required e.g. 'In Childhood, '10 years ago' the AllergyIntolerance.note element should be used.; (xsd)lastOccurrence:dateTime>?
[]< Additional narrative about the propensity for the Adverse Reaction, not captured in other fields. For example: including reason for flagging a seriousness of 'High Risk'; and instructions related to future exposure or administration of the substance, such as administration within an Intensive Care Unit or under corticosteroid cover. The notes should be related to an allergy or intolerance as a condition in general and not related to any particular episode of it. For episode notes and descriptions, use AllergyIntolerance.event.description and AllergyIntolerance.event.notes.; (xsd)note:Annotation>*
[]< Details about each adverse reaction event linked to exposure to the identified substance.; (xsd)reaction:AllergyIntolerance.reaction>*🔗 Indicates who or what participated in the activities related to the allergy or intolerance and how they were involved.AllergyIntolerance.participant(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Distinguishes the type of involvement of the actor in the activities related to the allergy or intolerance. Binding: participation-role-type (extensible, ); (xsd)function:CodeableConcept>?
< Indicates who or what participated in the activities related to the allergy or intolerance.; (xsd)actor:(<CareTeam>
|<Device>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>🔗 Details about each adverse reaction event linked to exposure to the identified substance.AllergyIntolerance.reaction(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Identification of the specific substance (or pharmaceutical product) considered to be responsible for the Adverse Reaction event. Note: the substance for a specific reaction may be different from the substance identified as the cause of the risk, but it must be consistent with it. For instance, it may be a more specific substance (e.g. a brand medication) or a composite product that includes the identified substance. It must be clinically safe to only process the 'code' and ignore the 'reaction.substance'. If a receiving system is unable to confirm that AllergyIntolerance.reaction.substance falls within the semantic scope of AllergyIntolerance.code, then the receiving system should ignore AllergyIntolerance.reaction.substance. Coding of the specific substance (or pharmaceutical product) with a terminology capable of triggering decision support should be used wherever possible. The 'code' element allows for the use of a specific substance or pharmaceutical product, or a group or class of substances. In the case of an allergy or intolerance to a class of substances, (for example, "penicillins"), the 'reaction.substance' element could be used to code the specific substance that was identified as having caused the reaction (for example, "amoxycillin"). Duplication of the value in the 'code' and 'reaction.substance' elements is acceptable when a specific substance has been recorded in 'code'. Binding: substance-code (example, Codes defining the type of the substance (including pharmaceutical products).); (xsd)substance:CodeableConcept>?
[]< Clinical symptoms and/or signs that are observed or associated with the adverse reaction event. Manifestation can be expressed as a single word, phrase or brief description. For example: nausea, rash or no reaction. It is preferable that manifestation should be coded with a terminology, where possible. The values entered here may be used to display on an application screen as part of a list of adverse reactions, as recommended in the UK NHS CUI guidelines. Terminologies commonly used include, but are not limited to, SNOMED CT or ICD10. Binding: clinical-findings (example, Clinical symptoms and/or signs that are observed or associated with an Adverse Reaction Event.); (xsd)manifestation:Observation*>+
< Text description about the reaction as a whole, including details of the manifestation if required. Use the description to provide any details of a particular event of the occurred reaction such as circumstances, reaction specifics, what happened before/after. Information, related to the event, but not describing a particular care should be captured in the note field. For example: at the age of four, the patient was given penicillin for strep throat and subsequently developed severe hives.; (xsd)description:string>?
< Record of the date and/or time of the onset of the Reaction.; (xsd)onset:dateTime>?
< Clinical assessment of the severity of the reaction event as a whole, potentially considering multiple different manifestations. It is acknowledged that this assessment is very subjective. There may be some specific practice domains where objective scales have been applied. Objective scales can be included in this model as extensions. Binding: reaction-event-severity (required, Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations.); (xsd)severity:code>?
< Identification of the route by which the subject was exposed to the substance. Coding of the route of exposure with a terminology should be used wherever possible. Binding: route-codes (example, A coded concept describing the route or physiological path of exposure to a substance.); (xsd)exposureRoute:CodeableConcept>?
[]< Additional text about the adverse reaction event not captured in other fields. Use this field to record information indirectly related to a particular event and not captured in the description. For example: Clinical records are no longer available, recorded based on information provided to the patient by her mother and her mother is deceased.; (xsd)note:Annotation>*🔗 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(xsd)(doc)=
<#base:DataType>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< The individual responsible for making the annotation. Organization is used when there's no need for specific attribution as to who made the comment.; (xsd)author:(<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>
|<string>)>?
< Indicates when this particular annotation was made.; (xsd)time:dateTime>?
< The text of the annotation in markdown format.; (xsd)text:markdown>🔗 A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s).Appointment(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< This records identifiers associated with this appointment concern that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).; (xsd)identifier:Identifier>*
< The overall status of the Appointment. Each of the participants has their own participation status which indicates their involvement in the process, however this status indicates the shared status. If the Appointment's status is "cancelled" then all participants are expected to have their calendars released for the appointment period, and as such any Slots that were marked as BUSY can be re-set to FREE.
This element is labeled as a modifier because the status contains the code entered-in-error that mark the Appointment as not currently valid. Binding: appointmentstatus (required, The free/busy status of an appointment.); (xsd)status:code>
< The coded reason for the appointment being cancelled. This is often used in reporting/billing/futher processing to determine if further actions are required, or specific fees apply. Binding: appointment-cancellation-reason (example, ); (xsd)cancellationReason:CodeableConcept>?
[]< Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations. Binding: http://terminology.hl7.org/ValueSet/EncounterClass (preferred, Classification of the encounter.); (xsd)class:CodeableConcept>*
[]< A broad categorization of the service that is to be performed during this appointment. Binding: service-category (example, ); (xsd)serviceCategory:CodeableConcept>*
[]< The specific service that is to be performed during this appointment. For a provider to provider appointment the code "FOLLOWUP" may be appropriate, as this is expected to be discussing some patient that was seen in the past. Binding: service-type (example, ); (xsd)serviceType:HealthcareService*>*
[]< The specialty of a practitioner that would be required to perform the service requested in this appointment. Binding: c80-practice-codes (preferred, ); (xsd)specialty:CodeableConcept>*
< The style of appointment or patient that has been booked in the slot (not service type). Binding: http://terminology.hl7.org/ValueSet/v2-0276 (preferred, ); (xsd)appointmentType:CodeableConcept>?
[]< The reason that this appointment is being scheduled. This is more clinical than administrative. This can be coded, or as specified using information from another resource. When the patient arrives and the encounter begins it may be used as the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure. Binding: encounter-reason (preferred, The Reason for the appointment to take place.); (xsd)reason:(<Condition>
|<ImmunizationRecommendation>
|<Observation>
|<Procedure>)>*
< The priority of the appointment. Can be used to make informed decisions if needing to re-prioritize appointments. (The iCal Standard specifies 0 as undefined, 1 as highest, 9 as lowest priority). Seeking implementer feedback on this property and how interoperable it is.
Using an extension to record a CodeableConcept for named values may be tested at a future connectathon. Binding: http://terminology.hl7.org/ValueSet/v3-ActPriority (example, Indicates the urgency of the appointment.); (xsd)priority:CodeableConcept>?
< The brief description of the appointment as would be shown on a subject line in a meeting request, or appointment list. Detailed or expanded information should be put in the note field.; (xsd)description:string>?
[]< Appointment replaced by this Appointment in cases where there is a cancellation, the details of the cancellation can be found in the cancellationReason property (on the referenced resource).; (xsd)replaces:Appointment*>*
[]< Connection details of a virtual service (e.g. conference call). There are two types of virtual meetings that often exist:
* a persistent, virtual meeting room that can only be used for a single purpose at a time,
* and a dynamic virtual meeting room that is generated on demand for a specific purpose.
Implementers may consider using Location.virtualService for persistent meeting rooms.
If each participant would have a different meeting link, an extension using the VirtualServiceContactDetail can be applied to the Appointment.participant BackboneElement.; (xsd)virtualService:VirtualServiceDetail>*
[]< Additional information to support the appointment provided when making the appointment.; (xsd)supportingInformation:Resource*>*
< The previous appointment in a series of related appointments. This property is intended for use when representing a series of related appointments. For example, in a nuclear medicine procedure, where there is an appointment for the injection of the isotopes, and then a subsequent appointment for the scan, the scan appointment would refer to the injection appointment via Appointment.previousAppointment. For representing recurring appointments, see the guidance on recurring vs. series appointments.; (xsd)previousAppointment:Appointment*>?
< The originating appointment in a recurring set of related appointments. This property is intended for use when representing a recurring set of related appointments.
For example, a patient undergoing physical therapy may have a recurring appointment every Tuesday and Thursday. Each occurrence of the set will refer to the originating appointment, which contains the recurring template information. For representing appointment series, see the guidance on recurring vs. series appointments.; (xsd)originatingAppointment:Appointment*>?
< Date/Time that the appointment is to take place. If actual start/end times are not known then the requested period start/end can be used.; (xsd)start:instant>?
< Date/Time that the appointment is to conclude. If actual start/end times are not known then the requested period start/end can be used.; (xsd)end:instant>?
< Number of minutes that the appointment is to take. This can be less than the duration between the start and end times. For example, where the actual time of appointment is only an estimate or if a 30 minute appointment is being requested, but any time would work. Also, if there is, for example, a planned 15 minute break in the middle of a long appointment, the duration may be 15 minutes less than the difference between the start and end.; (xsd)minutesDuration:positiveInt>?
[]< A set of date ranges (potentially including times) that the appointment is preferred to be scheduled within.
The duration (usually in minutes) could also be provided to indicate the length of the appointment to fill and populate the start/end times for the actual allocated time. However, in other situations the duration may be calculated by the scheduling system. This does not introduce a capacity for recurring appointments.; (xsd)requestedPeriod:Period>*
[]< The slots from the participants' schedules that will be filled by the appointment.; (xsd)slot:Slot*>*
[]< The set of accounts that is expected to be used for billing the activities that result from this Appointment. The specified account(s) could be those identified during pre-registration workflows in preparation for an upcoming Encounter.; (xsd)account:Account*>*
< The date that this appointment was initially created. This could be different to the meta.lastModified value on the initial entry, as this could have been before the resource was created on the FHIR server, and should remain unchanged over the lifespan of the appointment. This property is required for many use cases where the age of an appointment is considered in processing workflows for scheduling and billing of appointments.; (xsd)created:dateTime>?
< The date/time describing when the appointment was cancelled. If the appointment was cancelled multiple times, this would reflect the most recent cancellation.; (xsd)cancellationDate:dateTime>?
[]< Additional notes/comments about the appointment. Additional text to aid in facilitating the appointment. For instance, a note might be, "patient should proceed immediately to infusion room upon arrival"
Where this is a planned appointment and the start/end dates are not set then this field can be used to provide additional guidance on the details of the appointment request, including any restrictions on when to book it.
Typically only the concept.text will be used, however occasionally a reference to some generic documentation (or specific) and also supports coded instructions if/when they are required.; (xsd)note:Annotation>*
[]< While Appointment.note contains information for internal use, Appointment.patientInstructions is used to capture patient facing information about the Appointment (e.g. please bring your referral or fast from 8pm night before).; (xsd)patientInstruction:(<Binary>
|<Communication>
|<DocumentReference>)>*
[]< The request this appointment is allocated to assess (e.g. incoming referral or procedure request).; (xsd)basedOn:(<CarePlan>
|<DeviceRequest>
|<MedicationRequest>
|<ServiceRequest>)>*
< The patient or group associated with the appointment, if they are to be present (usually) then they should also be included in the participant backbone element.; (xsd)subject:(<Group>
|<Patient>)>?
[]< List of participants involved in the appointment.; (xsd)participant:Appointment.participant>+
< The sequence number that identifies a specific appointment in a recurring pattern.; (xsd)recurrenceId:positiveInt>?
< This appointment varies from the recurring pattern. For example, if a patient has physical therapy appointments every Tuesday and Thursday, but due to a national holiday, a single occurrence was rescheduled to a different day, while the rest of the recurring series remained on Tuesday / Thursday.; (xsd)occurrenceChanged:boolean>?
[]< The details of the recurrence pattern or template that is used to generate recurring appointments.; (xsd)recurrenceTemplate:Appointment.recurrenceTemplate>*🔗 List of participants involved in the appointment.Appointment.participant(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< Role of participant in the appointment. The role of the participant can be used to declare what the actor will be doing in the scope of this appointment.
If the actor is not specified, then it is expected that the actor will be filled in at a later stage of planning.
This value SHALL be the same when creating an AppointmentResponse so that they can be matched, and subsequently update the Appointment. Binding: encounter-participant-type (extensible, Role of participant in encounter.); (xsd)type:CodeableConcept>*
< Participation period of the actor.; (xsd)period:Period>?
< The individual, device, location, or service participating in the appointment. Where a CareTeam is provided, this does not imply that the entire team is included, just a single member from the group with the appropriate role. Where multiple members are required, please include the CareTeam the required number of times.; (xsd)actor:(<CareTeam>
|<Device>
|<Group>
|<HealthcareService>
|<Location>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>?
< Whether this participant is required to be present at the meeting. If false, the participant is optional. For the use-case where two doctors need to meet to discuss the results for a specific patient, and the patient is not required to be present include the patient in the subject field, but do not include them as a participant - this was formerly done prior to R5 with required='information-only'.; (xsd)required:boolean>?
< Participation status of the actor. Binding: participationstatus (required, The Participation status of an appointment.); (xsd)status:code>🔗 The details of the recurrence pattern or template that is used to generate recurring appointments.Appointment.recurrenceTemplate(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The timezone of the recurring appointment occurrences. Binding: timezones (required, IANA Timezones (BCP 175)); (xsd)timezone:CodeableConcept>?
< How often the appointment series should recur. Binding: appointment-recurrrence-type (preferred, IANA Timezones (BCP 175)); (xsd)recurrenceType:CodeableConcept>
< Recurring appointments will not occur after this date.; (xsd)lastOccurrenceDate:date>?
< How many appointments are planned in the recurrence.; (xsd)occurrenceCount:positiveInt>?
[]< The list of specific dates that will have appointments generated.; (xsd)occurrenceDate:date>*
< Information about weekly recurring appointments.; (xsd)weeklyTemplate:Appointment.recurrenceTemplate.weeklyTemplate>?
< Information about monthly recurring appointments.; (xsd)monthlyTemplate:Appointment.recurrenceTemplate.monthlyTemplate>?
< Information about yearly recurring appointments.; (xsd)yearlyTemplate:Appointment.recurrenceTemplate.yearlyTemplate>?
[]< Any dates, such as holidays, that should be excluded from the recurrence. excludingDate is an alternative to excludingRecurrenceId. You may say either that 12/25/XXXX should be excluded using excludingDate, or you may indicate the recurrenceId of the appointment that would fall on the excluded date in the excludingRecurrenceId property.; (xsd)excludingDate:date>*
[]< Any dates, such as holidays, that should be excluded from the recurrence. excludingRecurrenceId is an alternative to excludingDate. You may say either that 12/25/XXXX should be excluded using excludingDate, or you may indicate the recurrenceId of the appointment that would fall on the excluded date in the excludingRecurrenceId property.; (xsd)excludingRecurrenceId:positiveInt>*🔗 Information about monthly recurring appointments.Appointment.recurrenceTemplate.monthlyTemplate(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Indicates that appointments in the series of recurring appointments should occur on a specific day of the month.; (xsd)dayOfMonth:positiveInt>?
< Indicates which week within a month the appointments in the series of recurring appointments should occur on. Binding: week-of-month (required, The set of weeks in a month.); (xsd)nthWeekOfMonth:Coding>?
< Indicates which day of the week the recurring appointments should occur each nth week. This property is intended to be used with Appointment.recurrenceTemplate.monthly.nthWeek. Binding: days-of-week (required, The days of the week.); (xsd)dayOfWeek:Coding>?
< Indicates that recurring appointments should occur every nth month.; (xsd)monthInterval:positiveInt>🔗 Information about weekly recurring appointments.Appointment.recurrenceTemplate.weeklyTemplate(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Indicates that recurring appointments should occur on Mondays.; (xsd)monday:boolean>?
< Indicates that recurring appointments should occur on Tuesdays.; (xsd)tuesday:boolean>?
< Indicates that recurring appointments should occur on Wednesdays.; (xsd)wednesday:boolean>?
< Indicates that recurring appointments should occur on Thursdays.; (xsd)thursday:boolean>?
< Indicates that recurring appointments should occur on Fridays.; (xsd)friday:boolean>?
< Indicates that recurring appointments should occur on Saturdays.; (xsd)saturday:boolean>?
< Indicates that recurring appointments should occur on Sundays.; (xsd)sunday:boolean>?
< The interval defines if the recurrence is every nth week. The default is every week, so it is expected that this value will be 2 or more.
e.g. For recurring every second week this interval would be 2, or every third week the interval would be 3.; (xsd)weekInterval:positiveInt>?🔗 Information about yearly recurring appointments.Appointment.recurrenceTemplate.yearlyTemplate(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Appointment recurs every nth year.; (xsd)yearInterval:positiveInt>🔗 A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection.AppointmentResponse(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< This records identifiers associated with this appointment response concern that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate.; (xsd)identifier:Identifier>*
< Appointment that this response is replying to.; (xsd)appointment:Appointment*>
< Indicates that the response is proposing a different time that was initially requested. The new proposed time will be indicated in the start and end properties.; (xsd)proposedNewTime:boolean>?
< Date/Time that the appointment is to take place, or requested new start time. This may be either the same as the appointment request to confirm the details of the appointment, or alternately a new time to request a re-negotiation of the start time.; (xsd)start:instant>?
< This may be either the same as the appointment request to confirm the details of the appointment, or alternately a new time to request a re-negotiation of the end time.; (xsd)end:instant>?
[]< Role of participant in the appointment. The role of the participant can be used to declare what the actor will be doing in the scope of the referenced appointment.
If the actor is not specified, then it is expected that the actor will be filled in at a later stage of planning.
This value SHALL be the same as specified on the referenced Appointment so that they can be matched, and subsequently updated. Binding: encounter-participant-type (extensible, Role of participant in encounter.); (xsd)participantType:CodeableConcept>*
< A Person, Location, HealthcareService, or Device that is participating in the appointment.; (xsd)actor:(<Device>
|<Group>
|<HealthcareService>
|<Location>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>?
< Participation status of the participant. When the status is declined or tentative if the start/end times are different to the appointment, then these times should be interpreted as a requested time change. When the status is accepted, the times can either be the time of the appointment (as a confirmation of the time) or can be empty. This element is labeled as a modifier because the status contains the code entered-in-error that marks the participant as not currently valid. Binding: appointmentresponse-status (required, The Participation status of an appointment.); (xsd)participantStatus:code>
< Additional comments about the appointment. This comment is particularly important when the responder is declining, tentatively accepting or requesting another time to indicate the reasons why.; (xsd)comment:markdown>?
< Indicates that this AppointmentResponse applies to all occurrences in a recurring request. When a recurring appointment is requested, the participant may choose to respond to each individual occurrence, in which case AppointmentResponse.recurring should be false. If the participant chooses to respond the same way for all occurrences, they may instead use a single AppointmentResponse with recurring set to true. These may be combined as the participant chooses. For example, they may accept all occurrences (recurring = true), but then send a decline for a specific occurrence (recurring=false).; (xsd)recurring:boolean>?
< The original date within a recurring request. This could be used in place of the recurrenceId to be more direct (or where the template is provided through the simple list of dates in `Appointment.occurrenceDate`).; (xsd)occurrenceDate:date>?
< The recurrence ID (sequence number) of the specific appointment when responding to a recurring request. If the recurrence template was defined using the list of occurrenceDates then this property might not be used.; (xsd)recurrenceId:positiveInt>?🔗 This Resource provides one or more comments, classifiers or ratings about a Resource and supports attribution and rights management metadata for the added content.ArtifactAssessment(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< A formal identifier that is used to identify this artifact assessment when it is represented in other formats, or referenced in a specification, model, design or an instance. Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this activity definition outside of FHIR, where it is not possible to use the logical URI.; (xsd)identifier:Identifier>*
< A short title for the assessment for use in displaying and selecting.; (xsd)title:string>?
< Display of or reference to the bibliographic citation of the comment, classifier, or rating.; (xsd)citeAs:(<Citation>
|<markdown>)>?
< The date (and optionally time) when the artifact assessment was published. The date must change when the disposition changes and it must change if the workflow status code changes. In addition, it should change when the substantive content of the artifact assessment changes. The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the artifact assessment. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.; (xsd)date:dateTime>?
< A copyright statement relating to the artifact assessment and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the artifact assessment.; (xsd)copyright:markdown>?
< The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.; (xsd)approvalDate:date>?
< The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. If specified, this date follows the original approval date.; (xsd)lastReviewDate:date>?
< A reference to a resource, canonical resource, or non-FHIR resource which the comment or assessment is about.; (xsd)artifact:(<Resource>
|<uri>)>
[]< A component comment, classifier, or rating of the artifact.; (xsd)content:ArtifactAssessment.content>*
< Indicates the workflow status of the comment or change request. Binding: artifactassessment-workflow-status (required, ); (xsd)workflowStatus:code>?
< Indicates the disposition of the responsible party to the comment or change request. Binding: artifactassessment-disposition (required, ); (xsd)disposition:code>?🔗 A component comment, classifier, or rating of the artifact.ArtifactAssessment.content(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The type of information this component of the content represents. Binding: artifactassessment-information-type (required, ); (xsd)informationType:code>?
< A brief summary of the content of this component.; (xsd)summary:markdown>?
< Indicates what type of content this component represents. Binding: certainty-type (example, ); (xsd)type:CodeableConcept>?
[]< Represents a rating, classifier, or assessment of the artifact. Binding: certainty-rating (example, ); (xsd)classifier:CodeableConcept>*
< A quantitative rating of the artifact.; (xsd)quantity:Quantity>?
< Indicates who or what authored the content.; (xsd)author:(<Device>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>)>?
[]< A URI that points to what the comment is about, such as a line of text in the CQL, or a specific element in a resource. The target element is used to point the comment to aspect of the artifact, such as a text range within a CQL library (e.g. #content?0:0-120:80).; (xsd)path:uri>*
[]< Additional related artifacts that provide supporting documentation, additional evidence, or further information related to the content.; (xsd)relatedArtifact:RelatedArtifact>*
< Acceptable to publicly share the comment, classifier or rating.; (xsd)freeToShare:boolean>?
[]< If the informationType is container, the components of the content.; (xsd)component:ArtifactAssessment.content>*🔗 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(xsd)(doc)=
<#base:DataType>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< 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. Binding: mimetypes (required, BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)); (xsd)contentType:code>?
< The human language of the content. The value can be any valid value according to BCP 47. Binding: all-languages (required, IETF language tag for a human language.); (xsd)language:code>?
< 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.; (xsd)data:base64Binary>?
< 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.; (xsd)url>?
< 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.; (xsd)size:integer64>?
< 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.; (xsd)hash:base64Binary>?
< A label or set of text to display in place of the data. May sometimes be derived from the source filename.; (xsd)title:string>?
< The date that the attachment was first created.; (xsd)creation:dateTime>?
< Height of the image in pixels (photo/video).; (xsd)height:positiveInt>?
< Width of the image in pixels (photo/video).; (xsd)width:positiveInt>?
< The number of frames in a photo. This is used with a multi-page fax, or an imaging acquisition context that takes multiple slices in a single image, or an animated gif. If there is more than one frame, this SHALL have a value in order to alert interface software that a multi-frame capable rendering widget is required. if the number of frames is not supplied, the value may be unknown. Applications should not assume that there is only one frame unless it is explicitly stated.; (xsd)frames:positiveInt>?
< The duration of the recording in seconds - for audio and video. The duration might differ from occurrencePeriod if recording was paused.; (xsd)duration:decimal>?
< The number of pages when printed.; (xsd)pages:positiveInt>?🔗 A record of an event relevant for purposes such as operations, privacy, security, maintenance, and performance analysis. Based on IHE-ATNA.AuditEvent(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< Classification of the type of event. Binding: audit-event-type (example, Type of event.); (xsd)category:CodeableConcept>*
< Describes what happened. The most specific code for the event. Binding: audit-event-sub-type (example, Specific type of event.); (xsd)code:CodeableConcept>
< Indicator for type of action performed during the event that generated the audit. Binding: audit-event-action (required, DICOM Audit Event Action); (xsd)action:code>?
< Indicates and enables segmentation of various severity including debugging from critical. ATNA will map this to the SYSLOG PRI element. Binding: audit-event-severity (required, This is in the SysLog header, PRI. http://tools.ietf.org/html/rfc5424#appendix-A.3); (xsd)severity:code>?
< The time or period during which the activity occurred. The time or period can be a little arbitrary; where possible, the time should correspond to human assessment of the activity time.; (xsd)occurred:(<dateTime>
|<Period>)>?
< The time when the event was recorded. In a distributed system, some sort of common time base (e.g. an NTP [RFC1305] server) is a good implementation tactic.; (xsd)recorded:instant>
< Indicates whether the event succeeded or failed. A free text descripiton can be given in outcome.text. In some cases a "success" may be partial, for example, an incomplete or interrupted transfer of a radiological study. For the purpose of establishing accountability, these distinctions are not relevant.; (xsd)outcome:AuditEvent.outcome>?
[]< The authorization (e.g., PurposeOfUse) that was used during the event being recorded. Use AuditEvent.agent.authorization when you know that it is specific to the agent, otherwise use AuditEvent.authorization. For example, during a machine-to-machine transfer it might not be obvious to the audit system who caused the event, but it does know why. Binding: http://terminology.hl7.org/ValueSet/v3-PurposeOfUse (example, The authorized purposeOfUse for the activity.); (xsd)authorization:CodeableConcept>*
[]< Allows tracing of authorizatino for the events and tracking whether proposals/recommendations were acted upon.; (xsd)basedOn:(<CarePlan>
|<DeviceRequest>
|<ImmunizationRecommendation>
|<MedicationRequest>
|<NutritionOrder>
|<ServiceRequest>
|<Task>)>*
< The patient element is available to enable deterministic tracking of activities that involve the patient as the subject of the data used in an activity.; (xsd)patient:Patient*>?
< This will typically be the encounter the event occurred, but some events may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission lab tests).; (xsd)encounter:Encounter*>?
[]< An actor taking an active role in the event or activity that is logged. Several agents may be associated (i.e. have some responsibility for an activity) with an event or activity.
For example, an activity may be initiated by one user for other users or involve more than one user. However, only one user may be the initiator/requestor for the activity.
When a network are used in an event being recorded, there should be distinct agent elements for the known actors using the network. The agent with a network detail would be the responsible agent for use of that network.; (xsd)agent:AuditEvent.agent>+
< The actor that is reporting the event. Events are reported by the actor that detected them. This may be one of the participating actors, but may also be different. The actor may be a human such as a medical-records clerk disclosing data manually, that clerk would be the source for the record of disclosure.; (xsd)source:AuditEvent.source>
[]< Specific instances of data or objects that have been accessed. Required unless the values for event identification, agent identification, and audit source identification are sufficient to document the entire auditable event. Because events may have more than one entity, this group can be a repeating set of values.; (xsd)entity:AuditEvent.entity>*🔗 An actor taking an active role in the event or activity that is logged. Several agents may be associated (i.e. have some responsibility for an activity) with an event or activity.
For example, an activity may be initiated by one user for other users or involve more than one user. However, only one user may be the initiator/requestor for the activity.
When a network are used in an event being recorded, there should be distinct agent elements for the known actors using the network. The agent with a network detail would be the responsible agent for use of that network.AuditEvent.agent(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The Functional Role of the user when performing the event. For example: assembler, author, prescriber, signer, investigator, etc. Binding: participation-role-type (preferred, The Participation type of the agent to the event.); (xsd)type:CodeableConcept>?
[]< The structural roles of the agent indicating the agent's competency. The security role enabling the agent with respect to the activity. For example: Chief-of-Radiology, Nurse, Physician, Medical-Student, etc. Binding: security-role-type (example, What security role enabled the agent to participate in the event.); (xsd)role:CodeableConcept>*
< Reference to who this agent is that was involved in the event. Where a User ID is available it will go into who.identifier. Where a name of the user (human readable) it will go into who.display.; (xsd)who:(<CareTeam>
|<Device>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>
< Indicator that the user is or is not the requestor, or initiator, for the event being audited. There can only be one initiator. If the initiator is not clear, then do not choose any one agent as the initiator.; (xsd)requestor:boolean>?
< Where the agent location is known, the agent location when the event occurred.; (xsd)location:Location*>?
[]< Where the policy(ies) are known that authorized the agent participation in the event. Typically, a single activity may have multiple applicable policies, such as patient consent, guarantor funding, etc. The policy would also indicate the security token used. For example: Where an OAuth token authorizes, the unique identifier from the OAuth token is placed into the policy element Where a policy engine (e.g. XACML) holds policy logic, the unique policy identifier is placed into the policy element.; (xsd)policy:uri>*
< When the event utilizes a network there should be an agent describing the local system, and an agent describing remote system, with the network interface details. When remote network endpoint is known, another agent representing the remote agent would indicate the remote network endpoint used. Convention is to indicate data flowing from Source to Destination. The convention for Search, given data flows both ways (query parameters vs results), is to have the Source as the initiator of the Search Transaction, and the Destination the responder to the Search transaction.; (xsd)network:(<Endpoint>
|<string>
|<uri>)>?
[]< The authorization (e.g., PurposeOfUse) that was used during the event being recorded. Use AuditEvent.agent.authorization when you know that is specific to the agent, otherwise use AuditEvent.authorization. For example, during a machine-to-machine transfer it might not be obvious to the audit system who caused the event, but it does know why. Binding: http://terminology.hl7.org/ValueSet/v3-PurposeOfUse (example, The reason the activity took place.); (xsd)authorization:CodeableConcept>*🔗 Specific instances of data or objects that have been accessed. Required unless the values for event identification, agent identification, and audit source identification are sufficient to document the entire auditable event. Because events may have more than one entity, this group can be a repeating set of values.AuditEvent.entity(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Identifies a specific instance of the entity. The reference should be version specific. This is allowed to be a Parameters resource. Use .what.display when all you have is a string (e.g. ParticipantObjectName).; (xsd)what:Resource*>?
< Code representing the role the entity played in the event being audited. Binding: object-role (example, DICOM Audit Event Entity Role); (xsd)role:CodeableConcept>?
[]< Security labels for the identified entity. Copied from entity meta security tags. Binding: security-label-examples (example, Example Security Labels from the Healthcare Privacy and Security Classification System.); (xsd)securityLabel:CodeableConcept>*
< The query parameters for a query-type entities. The meaning and secondary-encoding of the content of base64 encoded blob is specific to the AuditEvent.type, AuditEvent.subtype, and AuditEvent.entity.role. The base64 is a general-use and safe container for event specific data blobs regardless of the encoding used by the transaction being recorded. An AuditEvent consuming application must understand the event it is consuming and the formats used by the event. For example, if auditing an Oracle network database access, the Oracle formats must be understood as they will be simply encoded in the base64binary blob.
The DICOM AuditMessage schema does not support both .name and .query being populated.; (xsd)query:base64Binary>?
[]< Tagged value pairs for conveying additional information about the entity.; (xsd)detail:AuditEvent.entity.detail>*
[]< The entity is attributed to an agent to express the agent's responsibility for that entity in the activity. This is most used to indicate when persistence media (the entity) are used by an agent. For example when importing data from a device, the device would be described in an entity, and the user importing data from that media would be indicated as the entity.agent. A usecase where one AuditEvent.entity.agent is used where the Entity that was used in the creation/updating of a target resource, is not in the context of the same custodianship as the target resource, and thus the meaning of AuditEvent.entity.agent is to say that the entity referenced is managed elsewhere and that this Agent provided access to it. This would be similar to where the Entity being referenced is managed outside FHIR, such as through HL7 V2, v3, or XDS. This might be where the Entity being referenced is managed in another FHIR resource server. Thus it explains the provenance of that Entity's use in the context of this AuditEvent activity.; (xsd)agent:AuditEvent.agent>*🔗 Tagged value pairs for conveying additional information about the entity.AuditEvent.entity.detail(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The type of extra detail provided in the value. Binding: audit-event-type (example, Additional detail about an entity used in an event.); (xsd)type:CodeableConcept>
(<valueBase64Binary:base64Binary>
|<valueBoolean:boolean>
|<valueCodeableConcept:CodeableConcept>
|<valueDateTime:dateTime>
|<valueInteger:integer>
|<valuePeriod:Period>
|<valueQuantity:Quantity>
|<valueRange:Range>
|<valueRatio:Ratio>
|<valueString:string>
|<valueTime:time>)🔗 Indicates whether the event succeeded or failed. A free text descripiton can be given in outcome.text. In some cases a "success" may be partial, for example, an incomplete or interrupted transfer of a radiological study. For the purpose of establishing accountability, these distinctions are not relevant.AuditEvent.outcome(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Indicates whether the event succeeded or failed. In some cases a "success" may be partial, for example, an incomplete or interrupted transfer of a radiological study. For the purpose of establishing accountability, these distinctions are not relevant. Binding: audit-event-outcome (preferred, DICOM Audit Event Outcome); (xsd)code:Coding>
[]< Additional details about the error. This may be a text description of the error or a system code that identifies the error. A human readable description of the error issue SHOULD be placed in details.text. Binding: audit-event-outcome-detail (example, A code that provides details as the exact issue.); (xsd)detail:CodeableConcept>*🔗 The actor that is reporting the event. Events are reported by the actor that detected them. This may be one of the participating actors, but may also be different. The actor may be a human such as a medical-records clerk disclosing data manually, that clerk would be the source for the record of disclosure.AuditEvent.source(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Logical source location within the healthcare enterprise network. For example, a hospital or other provider location within a multi-entity provider group.; (xsd)site:Location*>?
< Identifier of the source where the event was detected.; (xsd)observer:(<CareTeam>
|<Device>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>
[]< Code specifying the type of source where event originated. Binding: security-source-type (preferred, Code specifying the type of system that detected and recorded the event. Use of these codes is not required but is encouraged to maintain translation with DICOM AuditMessage schema.); (xsd)type:CodeableConcept>*🔗 Availability data for an {item}.Availability(xsd)(doc)=
<#base:DataType>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< Times the {item} is available.; (xsd)availableTime:Availability.availableTime>*
[]< Not available during this time due to provided reason.; (xsd)notAvailableTime:Availability.notAvailableTime>*🔗 Times the {item} is available.Availability.availableTime(xsd)(doc)=
<#base:Element>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< mon | tue | wed | thu | fri | sat | sun. Binding: days-of-week (required, The purpose for which an extended contact detail should be used.); (xsd)daysOfWeek:code>*
< Always available? i.e. 24 hour service.; (xsd)allDay:boolean>?
< Opening time of day (ignored if allDay = true). The timezone is expected to be specified or implied by the context this datatype is used.; (xsd)availableStartTime:time>?
< Closing time of day (ignored if allDay = true). The timezone is expected to be specified or implied by the context this datatype is used.; (xsd)availableEndTime:time>?🔗 Not available during this time due to provided reason.Availability.notAvailableTime(xsd)(doc)=
<#base:Element>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< Reason presented to the user explaining why time not available. The reason will generally be provided to give the textual reason for displaying when the {item} is not available, e.g. 'Closed public holidays' or 'Independence Day'. In cases such as this, the `during` might not be included and local knowledge would be required in such cases (as don't desire to keep updating when the holiday occurs each year).
e.g.2: 'Closed for maintenance over the summer' for this example you would want to include the `during` period, unless this was a university hospital and the "summer" period was well known, but would recommend its inclusion anyway.; (xsd)description:string>?
< Service not available during this period.; (xsd)during:Period>?🔗 Base definition for all elements that are defined inside a resource - but not those in a data type.BackboneElement(xsd)(doc)=
<#base:Element>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*🔗 Base definition for the few data types that are allowed to carry modifier extensions.BackboneType(xsd)(doc)=
<#base:DataType>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*🔗 Base definition for all types defined in FHIR type system.Base(xsd)(doc)=
<empty>🔗 A stream of bytes A stream of bytes, base64 encodedbase64Binary(xsd)(doc)=
<#base:PrimitiveType>
< unique id for the element within a resource (for internal references); (xsd)id:string>?
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< The actual value; (xsd)value:string>?🔗 Basic is used for handling concepts not yet defined in FHIR, narrative-only resources that don't map to an existing resource, and custom resources not appropriate for inclusion in the FHIR specification.Basic(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< Identifier assigned to the resource for business purposes, outside the context of FHIR.; (xsd)identifier:Identifier>*
< Identifies the 'type' of resource - equivalent to the resource name for other resources. Because resource references will only be able to indicate 'Basic', the type of reference will need to be specified in a Profile identified as part of the resource. Refer to the resource notes section for information on appropriate terminologies for this code.
This element is labeled as a modifier because it defines the meaning of the resource and cannot be ignored. Binding: basic-resource-type (example, HL7-maintained set of codes for "Basic" resources); (xsd)code:CodeableConcept>
< Identifies the patient, practitioner, device or any other resource that is the "focus" of this resource. Optional as not all potential resources will have subjects. Resources associated with multiple subjects can handle this via extension.; (xsd)subject:Resource*>?
< Identifies when the resource was first created.; (xsd)created:dateTime>?
< Indicates who was responsible for creating the resource instance.; (xsd)author:(<CareTeam>
|<Device>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>?🔗 A container for a collection of resources.batch-bundle(xsd)(doc)=
<#base:Bundle>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< A persistent identifier for the bundle that won't change as a bundle is copied from server to server. Persistent identity generally only matters for batches of type Document, Message, and Collection. It would not normally be populated for search and history results and servers ignore Bundle.identifier when processing batches and transactions. For Documents the .identifier SHALL be populated such that the .identifier is globally unique.; (xsd)identifier:Identifier>?
< Indicates the purpose of this bundle - how it is intended to be used. It's possible to use a bundle for other purposes (e.g. a document can be accepted as a transaction). This is primarily defined so that there can be specific rules for some of the bundle types. Binding: bundle-type (required, Indicates the purpose of a bundle - how it is intended to be used.); (xsd)type:code>
< The date/time that the bundle was assembled - i.e. when the resources were placed in the bundle. For many bundles, the timestamp is equal to .meta.lastUpdated, because they are not stored (e.g. search results). When a bundle is placed in a persistent store, .meta.lastUpdated will be usually be changed by the server. When the bundle is a message, a middleware agent altering the message (even if not stored) SHOULD update .meta.lastUpdated. .timestamp is used to track the original time of the Bundle, and SHOULD be populated.
Usage:
* document : the date the document was created. Note: the composition may predate the document, or be associated with multiple documents. The date of the composition - the authoring time - may be earlier than the document assembly time
* message : the date that the content of the message was assembled. This date is not changed by middleware engines unless they add additional data that changes the meaning of the time of the message
* history : the date that the history was assembled. This time would be used as the _since time to ask for subsequent updates
* searchset : the time that the search set was assembled. Note that different pages MAY have different timestamps but need not. Having different timestamps does not imply that subsequent pages will represent or include changes made since the initial query
* transaction | transaction-response | batch | batch-response | collection : no particular assigned meaning
The timestamp value should be greater than the lastUpdated and other timestamps in the resources in the bundle, and it should be equal or earlier than the .meta.lastUpdated on the Bundle itself.; (xsd)timestamp:instant>?
< If a set of search matches, this is the (potentially estimated) total number of entries of type 'match' across all pages in the search. It does not include search.mode = 'include' or 'outcome' entries and it does not provide a count of the number of entries in the Bundle. Only used if the bundle is a search result set. The total does not include resources such as OperationOutcome and included resources, only the total number of matching resources.; (xsd)total:unsignedInt>{0,0}
[]< A series of links that provide context to this bundle. Both Bundle.link and Bundle.entry.link are defined to support providing additional context when Bundles are used (e.g. [HATEOAS](http://en.wikipedia.org/wiki/HATEOAS)).
Bundle.entry.link corresponds to links found in the HTTP header if the resource in the entry was [read](http.html#read) directly.
This specification defines some specific uses of Bundle.link for [searching](search.html#conformance) and [paging](http.html#paging), but no specific uses for Bundle.entry.link, and no defined function in a transaction - the meaning is implementation specific. The behavior of navigation link types (next/prev/first/last) are well defined for searchset and history Bundles but are not currently defined for other types. Implementers who choose to use such link relationships for other bundle types will need to negotiate behavior with their interoperability partners.; (xsd)link:batch-bundle.link>*
[]< An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).; (xsd)entry:batch-bundle.entry>*
< Digital Signature - base64 encoded. XML-DSig or a JWS. The signature could be created by the "author" of the bundle or by the originating device. Requirements around inclusion of a signature, verification of signatures and treatment of signed/non-signed bundles is implementation-environment specific.; (xsd)signature:Signature>?
< Captures issues and warnings that relate to the construction of the Bundle and the content within it. Usage notes: These issues and warnings must apply to the Bundle as a whole, not to individual entries.Messages relating to the processing of individual entries (e.g. in a batch or transaction) SHALL be reported in the entry.response.outcome for that entry. If there are errors that arise in the creation of the Bundle, then that should be handled by an OperationOutcome being returned instead of the Bundle.; (xsd)issues:OperationOutcome>?
[]< An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).; (xsd)put:batch-bundle.put>*
[]< An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).; (xsd)post:batch-bundle.post>*
[]< An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).; (xsd)get:batch-bundle.get>*
[]< An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).; (xsd)delete:batch-bundle.delete>*
[]< An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).; (xsd)patch:batch-bundle.patch>*
[]< An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).; (xsd)head:batch-bundle.head>*🔗 An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).batch-bundle.delete(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< A series of links that provide context to this entry.; (xsd)link:Bundle.link>*
< The Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when:
* invoking a create
* invoking or responding to an operation where the body is not a single identified resource
* invoking or returning the results of a search or history operation. fullUrl might not be [unique in the context of a resource](bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](references.html), the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the [regex](references.html#regex), then the 'id' portion of the fullUrl SHALL end with the Resource.id.
Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).; (xsd)fullUrl:uri>
< The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. This is allowed to be a Parameters resource if and only if it is referenced by something else within the Bundle that provides context/meaning.; (xsd)resource:Resource>{0,0}
< Information about the search process that lead to the creation of this entry.; (xsd)search:batch-bundle.delete.search>{0,0}
< Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.; (xsd)request:batch-bundle.delete.request>
< Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.; (xsd)response:batch-bundle.delete.response>{0,0}🔗 Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.batch-bundle.delete.request(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred. Binding: http-verb (required, HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details.); (xsd)method:code>
< The URL for this entry, relative to the root (the address to which the request is posted). E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]".; (xsd)url:uri>
< If the ETag values match, return a 304 Not Modified status. See the API documentation for ["Conditional Read"](http.html#cread).; (xsd)ifNoneMatch:string>?
< Only perform the operation if the last updated date matches. See the API documentation for ["Conditional Read"](http.html#cread).; (xsd)ifModifiedSince:instant>?
< Only perform the operation if the Etag value matches. For more information, see the API section ["Managing Resource Contention"](http.html#concurrency).; (xsd)ifMatch:string>?
< Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for ["Conditional Create"](http.html#ccreate). This is just the query portion of the URL - what follows the "?" (not including the "?").; (xsd)ifNoneExist:string>?🔗 Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.batch-bundle.delete.response(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.; (xsd)status:string>
< The location header created by processing this operation, populated if the operation returns a location.; (xsd)location:uri>?
< The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)). Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.; (xsd)etag:string>?
< The date/time that the resource was modified on the server. This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.; (xsd)lastModified:instant>?
< An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction. For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.
This outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.; (xsd)outcome:Resource>?🔗 Information about the search process that lead to the creation of this entry.batch-bundle.delete.search(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence. Binding: search-entry-mode (required, Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.); (xsd)mode:code>?
< When searching, the server's search ranking score for the entry. Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.
See [Patient Match](patient-operation-match.html) for the EMPI search which relates to this element.; (xsd)score:decimal>?🔗 An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).batch-bundle.entry(xsd)(doc)=
<#base:Bundle.entry>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< A series of links that provide context to this entry.; (xsd)link:Bundle.link>*
< The Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when:
* invoking a create
* invoking or responding to an operation where the body is not a single identified resource
* invoking or returning the results of a search or history operation. fullUrl might not be [unique in the context of a resource](bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](references.html), the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the [regex](references.html#regex), then the 'id' portion of the fullUrl SHALL end with the Resource.id.
Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).; (xsd)fullUrl:uri>?
< The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. This is allowed to be a Parameters resource if and only if it is referenced by something else within the Bundle that provides context/meaning.; (xsd)resource:Resource>?
< Information about the search process that lead to the creation of this entry.; (xsd)search:batch-bundle.entry.search>?
< Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.; (xsd)request:batch-bundle.entry.request>?
< Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.; (xsd)response:batch-bundle.entry.response>?🔗 Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.batch-bundle.entry.request(xsd)(doc)=
<#base:Bundle.entry.request>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred. Binding: http-verb (required, HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details.); (xsd)method:code>
< The URL for this entry, relative to the root (the address to which the request is posted). E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]".; (xsd)url:uri>
< If the ETag values match, return a 304 Not Modified status. See the API documentation for ["Conditional Read"](http.html#cread).; (xsd)ifNoneMatch:string>?
< Only perform the operation if the last updated date matches. See the API documentation for ["Conditional Read"](http.html#cread).; (xsd)ifModifiedSince:instant>?
< Only perform the operation if the Etag value matches. For more information, see the API section ["Managing Resource Contention"](http.html#concurrency).; (xsd)ifMatch:string>?
< Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for ["Conditional Create"](http.html#ccreate). This is just the query portion of the URL - what follows the "?" (not including the "?").; (xsd)ifNoneExist:string>?🔗 Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.batch-bundle.entry.response(xsd)(doc)=
<#base:Bundle.entry.response>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.; (xsd)status:string>
< The location header created by processing this operation, populated if the operation returns a location.; (xsd)location:uri>?
< The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)). Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.; (xsd)etag:string>?
< The date/time that the resource was modified on the server. This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.; (xsd)lastModified:instant>?
< An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction. For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.
This outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.; (xsd)outcome:Resource>?🔗 Information about the search process that lead to the creation of this entry.batch-bundle.entry.search(xsd)(doc)=
<#base:Bundle.entry.search>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence. Binding: search-entry-mode (required, Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.); (xsd)mode:code>?
< When searching, the server's search ranking score for the entry. Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.
See [Patient Match](patient-operation-match.html) for the EMPI search which relates to this element.; (xsd)score:decimal>?🔗 An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).batch-bundle.get(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< A series of links that provide context to this entry.; (xsd)link:Bundle.link>*
< The Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when:
* invoking a create
* invoking or responding to an operation where the body is not a single identified resource
* invoking or returning the results of a search or history operation. fullUrl might not be [unique in the context of a resource](bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](references.html), the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the [regex](references.html#regex), then the 'id' portion of the fullUrl SHALL end with the Resource.id.
Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).; (xsd)fullUrl:uri>
< The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. This is allowed to be a Parameters resource if and only if it is referenced by something else within the Bundle that provides context/meaning.; (xsd)resource:Resource>{0,0}
< Information about the search process that lead to the creation of this entry.; (xsd)search:batch-bundle.get.search>{0,0}
< Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.; (xsd)request:batch-bundle.get.request>
< Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.; (xsd)response:batch-bundle.get.response>{0,0}🔗 Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.batch-bundle.get.request(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred. Binding: http-verb (required, HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details.); (xsd)method:code>
< The URL for this entry, relative to the root (the address to which the request is posted). E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]".; (xsd)url:uri>
< If the ETag values match, return a 304 Not Modified status. See the API documentation for ["Conditional Read"](http.html#cread).; (xsd)ifNoneMatch:string>?
< Only perform the operation if the last updated date matches. See the API documentation for ["Conditional Read"](http.html#cread).; (xsd)ifModifiedSince:instant>?
< Only perform the operation if the Etag value matches. For more information, see the API section ["Managing Resource Contention"](http.html#concurrency).; (xsd)ifMatch:string>?
< Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for ["Conditional Create"](http.html#ccreate). This is just the query portion of the URL - what follows the "?" (not including the "?").; (xsd)ifNoneExist:string>?🔗 Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.batch-bundle.get.response(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.; (xsd)status:string>
< The location header created by processing this operation, populated if the operation returns a location.; (xsd)location:uri>?
< The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)). Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.; (xsd)etag:string>?
< The date/time that the resource was modified on the server. This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.; (xsd)lastModified:instant>?
< An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction. For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.
This outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.; (xsd)outcome:Resource>?🔗 Information about the search process that lead to the creation of this entry.batch-bundle.get.search(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence. Binding: search-entry-mode (required, Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.); (xsd)mode:code>?
< When searching, the server's search ranking score for the entry. Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.
See [Patient Match](patient-operation-match.html) for the EMPI search which relates to this element.; (xsd)score:decimal>?🔗 An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).batch-bundle.head(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< A series of links that provide context to this entry.; (xsd)link:Bundle.link>*
< The Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when:
* invoking a create
* invoking or responding to an operation where the body is not a single identified resource
* invoking or returning the results of a search or history operation. fullUrl might not be [unique in the context of a resource](bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](references.html), the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the [regex](references.html#regex), then the 'id' portion of the fullUrl SHALL end with the Resource.id.
Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).; (xsd)fullUrl:uri>
< The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. This is allowed to be a Parameters resource if and only if it is referenced by something else within the Bundle that provides context/meaning.; (xsd)resource:Resource>{0,0}
< Information about the search process that lead to the creation of this entry.; (xsd)search:batch-bundle.head.search>{0,0}
< Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.; (xsd)request:batch-bundle.head.request>
< Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.; (xsd)response:batch-bundle.head.response>{0,0}🔗 Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.batch-bundle.head.request(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred. Binding: http-verb (required, HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details.); (xsd)method:code>
< The URL for this entry, relative to the root (the address to which the request is posted). E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]".; (xsd)url:uri>
< If the ETag values match, return a 304 Not Modified status. See the API documentation for ["Conditional Read"](http.html#cread).; (xsd)ifNoneMatch:string>?
< Only perform the operation if the last updated date matches. See the API documentation for ["Conditional Read"](http.html#cread).; (xsd)ifModifiedSince:instant>?
< Only perform the operation if the Etag value matches. For more information, see the API section ["Managing Resource Contention"](http.html#concurrency).; (xsd)ifMatch:string>?
< Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for ["Conditional Create"](http.html#ccreate). This is just the query portion of the URL - what follows the "?" (not including the "?").; (xsd)ifNoneExist:string>?🔗 Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.batch-bundle.head.response(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.; (xsd)status:string>
< The location header created by processing this operation, populated if the operation returns a location.; (xsd)location:uri>?
< The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)). Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.; (xsd)etag:string>?
< The date/time that the resource was modified on the server. This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.; (xsd)lastModified:instant>?
< An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction. For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.
This outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.; (xsd)outcome:Resource>?🔗 Information about the search process that lead to the creation of this entry.batch-bundle.head.search(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence. Binding: search-entry-mode (required, Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.); (xsd)mode:code>?
< When searching, the server's search ranking score for the entry. Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.
See [Patient Match](patient-operation-match.html) for the EMPI search which relates to this element.; (xsd)score:decimal>?🔗 A series of links that provide context to this bundle. Both Bundle.link and Bundle.entry.link are defined to support providing additional context when Bundles are used (e.g. [HATEOAS](http://en.wikipedia.org/wiki/HATEOAS)).
Bundle.entry.link corresponds to links found in the HTTP header if the resource in the entry was [read](http.html#read) directly.
This specification defines some specific uses of Bundle.link for [searching](search.html#conformance) and [paging](http.html#paging), but no specific uses for Bundle.entry.link, and no defined function in a transaction - the meaning is implementation specific. The behavior of navigation link types (next/prev/first/last) are well defined for searchset and history Bundles but are not currently defined for other types. Implementers who choose to use such link relationships for other bundle types will need to negotiate behavior with their interoperability partners.batch-bundle.link(xsd)(doc)=
<#base:Bundle.link>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A name which details the functional use for this link - see [http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1](http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1). Binding: iana-link-relations (required, ); (xsd)relation:code>
< The reference details for the link.; (xsd)url:uri>🔗 An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).batch-bundle.patch(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< A series of links that provide context to this entry.; (xsd)link:Bundle.link>*
< The Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when:
* invoking a create
* invoking or responding to an operation where the body is not a single identified resource
* invoking or returning the results of a search or history operation. fullUrl might not be [unique in the context of a resource](bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](references.html), the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the [regex](references.html#regex), then the 'id' portion of the fullUrl SHALL end with the Resource.id.
Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).; (xsd)fullUrl:uri>
< The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. This is allowed to be a Parameters resource if and only if it is referenced by something else within the Bundle that provides context/meaning.; (xsd)resource:Resource>
< Information about the search process that lead to the creation of this entry.; (xsd)search:batch-bundle.patch.search>{0,0}
< Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.; (xsd)request:batch-bundle.patch.request>
< Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.; (xsd)response:batch-bundle.patch.response>{0,0}🔗 Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.batch-bundle.patch.request(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred. Binding: http-verb (required, HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details.); (xsd)method:code>
< The URL for this entry, relative to the root (the address to which the request is posted). E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]".; (xsd)url:uri>
< If the ETag values match, return a 304 Not Modified status. See the API documentation for ["Conditional Read"](http.html#cread).; (xsd)ifNoneMatch:string>?
< Only perform the operation if the last updated date matches. See the API documentation for ["Conditional Read"](http.html#cread).; (xsd)ifModifiedSince:instant>?
< Only perform the operation if the Etag value matches. For more information, see the API section ["Managing Resource Contention"](http.html#concurrency).; (xsd)ifMatch:string>?
< Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for ["Conditional Create"](http.html#ccreate). This is just the query portion of the URL - what follows the "?" (not including the "?").; (xsd)ifNoneExist:string>?🔗 Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.batch-bundle.patch.response(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.; (xsd)status:string>
< The location header created by processing this operation, populated if the operation returns a location.; (xsd)location:uri>?
< The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)). Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.; (xsd)etag:string>?
< The date/time that the resource was modified on the server. This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.; (xsd)lastModified:instant>?
< An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction. For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.
This outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.; (xsd)outcome:Resource>?🔗 Information about the search process that lead to the creation of this entry.batch-bundle.patch.search(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence. Binding: search-entry-mode (required, Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.); (xsd)mode:code>?
< When searching, the server's search ranking score for the entry. Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.
See [Patient Match](patient-operation-match.html) for the EMPI search which relates to this element.; (xsd)score:decimal>?🔗 An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).batch-bundle.post(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< A series of links that provide context to this entry.; (xsd)link:Bundle.link>*
< The Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when:
* invoking a create
* invoking or responding to an operation where the body is not a single identified resource
* invoking or returning the results of a search or history operation. fullUrl might not be [unique in the context of a resource](bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](references.html), the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the [regex](references.html#regex), then the 'id' portion of the fullUrl SHALL end with the Resource.id.
Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).; (xsd)fullUrl:uri>?
< The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. This is allowed to be a Parameters resource if and only if it is referenced by something else within the Bundle that provides context/meaning.; (xsd)resource:Resource>
< Information about the search process that lead to the creation of this entry.; (xsd)search:batch-bundle.post.search>{0,0}
< Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.; (xsd)request:batch-bundle.post.request>
< Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.; (xsd)response:batch-bundle.post.response>{0,0}🔗 Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.batch-bundle.post.request(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred. Binding: http-verb (required, HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details.); (xsd)method:code>
< The URL for this entry, relative to the root (the address to which the request is posted). E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]".; (xsd)url:uri>
< If the ETag values match, return a 304 Not Modified status. See the API documentation for ["Conditional Read"](http.html#cread).; (xsd)ifNoneMatch:string>?
< Only perform the operation if the last updated date matches. See the API documentation for ["Conditional Read"](http.html#cread).; (xsd)ifModifiedSince:instant>?
< Only perform the operation if the Etag value matches. For more information, see the API section ["Managing Resource Contention"](http.html#concurrency).; (xsd)ifMatch:string>?
< Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for ["Conditional Create"](http.html#ccreate). This is just the query portion of the URL - what follows the "?" (not including the "?").; (xsd)ifNoneExist:string>?🔗 Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.batch-bundle.post.response(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.; (xsd)status:string>
< The location header created by processing this operation, populated if the operation returns a location.; (xsd)location:uri>?
< The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)). Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.; (xsd)etag:string>?
< The date/time that the resource was modified on the server. This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.; (xsd)lastModified:instant>?
< An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction. For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.
This outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.; (xsd)outcome:Resource>?🔗 Information about the search process that lead to the creation of this entry.batch-bundle.post.search(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence. Binding: search-entry-mode (required, Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.); (xsd)mode:code>?
< When searching, the server's search ranking score for the entry. Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.
See [Patient Match](patient-operation-match.html) for the EMPI search which relates to this element.; (xsd)score:decimal>?🔗 An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).batch-bundle.put(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< A series of links that provide context to this entry.; (xsd)link:Bundle.link>*
< The Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when:
* invoking a create
* invoking or responding to an operation where the body is not a single identified resource
* invoking or returning the results of a search or history operation. fullUrl might not be [unique in the context of a resource](bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](references.html), the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the [regex](references.html#regex), then the 'id' portion of the fullUrl SHALL end with the Resource.id.
Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).; (xsd)fullUrl:uri>
< The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. This is allowed to be a Parameters resource if and only if it is referenced by something else within the Bundle that provides context/meaning.; (xsd)resource:Resource>
< Information about the search process that lead to the creation of this entry.; (xsd)search:batch-bundle.put.search>{0,0}
< Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.; (xsd)request:batch-bundle.put.request>
< Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.; (xsd)response:batch-bundle.put.response>{0,0}🔗 Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.batch-bundle.put.request(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred. Binding: http-verb (required, HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details.); (xsd)method:code>
< The URL for this entry, relative to the root (the address to which the request is posted). E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]".; (xsd)url:uri>
< If the ETag values match, return a 304 Not Modified status. See the API documentation for ["Conditional Read"](http.html#cread).; (xsd)ifNoneMatch:string>?
< Only perform the operation if the last updated date matches. See the API documentation for ["Conditional Read"](http.html#cread).; (xsd)ifModifiedSince:instant>?
< Only perform the operation if the Etag value matches. For more information, see the API section ["Managing Resource Contention"](http.html#concurrency).; (xsd)ifMatch:string>?
< Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for ["Conditional Create"](http.html#ccreate). This is just the query portion of the URL - what follows the "?" (not including the "?").; (xsd)ifNoneExist:string>?🔗 Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.batch-bundle.put.response(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.; (xsd)status:string>
< The location header created by processing this operation, populated if the operation returns a location.; (xsd)location:uri>?
< The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)). Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.; (xsd)etag:string>?
< The date/time that the resource was modified on the server. This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.; (xsd)lastModified:instant>?
< An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction. For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.
This outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.; (xsd)outcome:Resource>?🔗 Information about the search process that lead to the creation of this entry.batch-bundle.put.search(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence. Binding: search-entry-mode (required, Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.); (xsd)mode:code>?
< When searching, the server's search ranking score for the entry. Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.
See [Patient Match](patient-operation-match.html) for the EMPI search which relates to this element.; (xsd)score:decimal>?🔗 A container for a collection of resources.batch-response-bundle(xsd)(doc)=
<#base:Bundle>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< A persistent identifier for the bundle that won't change as a bundle is copied from server to server. Persistent identity generally only matters for batches of type Document, Message, and Collection. It would not normally be populated for search and history results and servers ignore Bundle.identifier when processing batches and transactions. For Documents the .identifier SHALL be populated such that the .identifier is globally unique.; (xsd)identifier:Identifier>?
< Indicates the purpose of this bundle - how it is intended to be used. It's possible to use a bundle for other purposes (e.g. a document can be accepted as a transaction). This is primarily defined so that there can be specific rules for some of the bundle types. Binding: bundle-type (required, Indicates the purpose of a bundle - how it is intended to be used.); (xsd)type:code>
< The date/time that the bundle was assembled - i.e. when the resources were placed in the bundle. For many bundles, the timestamp is equal to .meta.lastUpdated, because they are not stored (e.g. search results). When a bundle is placed in a persistent store, .meta.lastUpdated will be usually be changed by the server. When the bundle is a message, a middleware agent altering the message (even if not stored) SHOULD update .meta.lastUpdated. .timestamp is used to track the original time of the Bundle, and SHOULD be populated.
Usage:
* document : the date the document was created. Note: the composition may predate the document, or be associated with multiple documents. The date of the composition - the authoring time - may be earlier than the document assembly time
* message : the date that the content of the message was assembled. This date is not changed by middleware engines unless they add additional data that changes the meaning of the time of the message
* history : the date that the history was assembled. This time would be used as the _since time to ask for subsequent updates
* searchset : the time that the search set was assembled. Note that different pages MAY have different timestamps but need not. Having different timestamps does not imply that subsequent pages will represent or include changes made since the initial query
* transaction | transaction-response | batch | batch-response | collection : no particular assigned meaning
The timestamp value should be greater than the lastUpdated and other timestamps in the resources in the bundle, and it should be equal or earlier than the .meta.lastUpdated on the Bundle itself.; (xsd)timestamp:instant>?
< If a set of search matches, this is the (potentially estimated) total number of entries of type 'match' across all pages in the search. It does not include search.mode = 'include' or 'outcome' entries and it does not provide a count of the number of entries in the Bundle. Only used if the bundle is a search result set. The total does not include resources such as OperationOutcome and included resources, only the total number of matching resources.; (xsd)total:unsignedInt>{0,0}
[]< A series of links that provide context to this bundle. Both Bundle.link and Bundle.entry.link are defined to support providing additional context when Bundles are used (e.g. [HATEOAS](http://en.wikipedia.org/wiki/HATEOAS)).
Bundle.entry.link corresponds to links found in the HTTP header if the resource in the entry was [read](http.html#read) directly.
This specification defines some specific uses of Bundle.link for [searching](search.html#conformance) and [paging](http.html#paging), but no specific uses for Bundle.entry.link, and no defined function in a transaction - the meaning is implementation specific. The behavior of navigation link types (next/prev/first/last) are well defined for searchset and history Bundles but are not currently defined for other types. Implementers who choose to use such link relationships for other bundle types will need to negotiate behavior with their interoperability partners.; (xsd)link:batch-response-bundle.link>*
[]< An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).; (xsd)entry:batch-response-bundle.entry>*
< Digital Signature - base64 encoded. XML-DSig or a JWS. The signature could be created by the "author" of the bundle or by the originating device. Requirements around inclusion of a signature, verification of signatures and treatment of signed/non-signed bundles is implementation-environment specific.; (xsd)signature:Signature>?
< Captures issues and warnings that relate to the construction of the Bundle and the content within it. Usage notes: These issues and warnings must apply to the Bundle as a whole, not to individual entries.Messages relating to the processing of individual entries (e.g. in a batch or transaction) SHALL be reported in the entry.response.outcome for that entry. If there are errors that arise in the creation of the Bundle, then that should be handled by an OperationOutcome being returned instead of the Bundle.; (xsd)issues:OperationOutcome>?🔗 An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).batch-response-bundle.entry(xsd)(doc)=
<#base:Bundle.entry>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< A series of links that provide context to this entry.; (xsd)link:Bundle.link>*
< The Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when:
* invoking a create
* invoking or responding to an operation where the body is not a single identified resource
* invoking or returning the results of a search or history operation. fullUrl might not be [unique in the context of a resource](bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](references.html), the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the [regex](references.html#regex), then the 'id' portion of the fullUrl SHALL end with the Resource.id.
Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).; (xsd)fullUrl:uri>
< The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. This is allowed to be a Parameters resource if and only if it is referenced by something else within the Bundle that provides context/meaning.; (xsd)resource:Resource>?
< Information about the search process that lead to the creation of this entry.; (xsd)search:batch-response-bundle.entry.search>{0,0}
< Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.; (xsd)request:batch-response-bundle.entry.request>{0,0}
< Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.; (xsd)response:batch-response-bundle.entry.response>?🔗 Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.batch-response-bundle.entry.request(xsd)(doc)=
<#base:Bundle.entry.request>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred. Binding: http-verb (required, HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details.); (xsd)method:code>
< The URL for this entry, relative to the root (the address to which the request is posted). E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]".; (xsd)url:uri>
< If the ETag values match, return a 304 Not Modified status. See the API documentation for ["Conditional Read"](http.html#cread).; (xsd)ifNoneMatch:string>?
< Only perform the operation if the last updated date matches. See the API documentation for ["Conditional Read"](http.html#cread).; (xsd)ifModifiedSince:instant>?
< Only perform the operation if the Etag value matches. For more information, see the API section ["Managing Resource Contention"](http.html#concurrency).; (xsd)ifMatch:string>?
< Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for ["Conditional Create"](http.html#ccreate). This is just the query portion of the URL - what follows the "?" (not including the "?").; (xsd)ifNoneExist:string>?🔗 Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.batch-response-bundle.entry.response(xsd)(doc)=
<#base:Bundle.entry.response>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.; (xsd)status:string>
< The location header created by processing this operation, populated if the operation returns a location.; (xsd)location:uri>?
< The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)). Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.; (xsd)etag:string>?
< The date/time that the resource was modified on the server. This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.; (xsd)lastModified:instant>?
< An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction. For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.
This outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.; (xsd)outcome:Resource>?🔗 Information about the search process that lead to the creation of this entry.batch-response-bundle.entry.search(xsd)(doc)=
<#base:Bundle.entry.search>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence. Binding: search-entry-mode (required, Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.); (xsd)mode:code>?
< When searching, the server's search ranking score for the entry. Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.
See [Patient Match](patient-operation-match.html) for the EMPI search which relates to this element.; (xsd)score:decimal>?🔗 A series of links that provide context to this bundle. Both Bundle.link and Bundle.entry.link are defined to support providing additional context when Bundles are used (e.g. [HATEOAS](http://en.wikipedia.org/wiki/HATEOAS)).
Bundle.entry.link corresponds to links found in the HTTP header if the resource in the entry was [read](http.html#read) directly.
This specification defines some specific uses of Bundle.link for [searching](search.html#conformance) and [paging](http.html#paging), but no specific uses for Bundle.entry.link, and no defined function in a transaction - the meaning is implementation specific. The behavior of navigation link types (next/prev/first/last) are well defined for searchset and history Bundles but are not currently defined for other types. Implementers who choose to use such link relationships for other bundle types will need to negotiate behavior with their interoperability partners.batch-response-bundle.link(xsd)(doc)=
<#base:Bundle.link>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A name which details the functional use for this link - see [http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1](http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1). Binding: iana-link-relations (required, ); (xsd)relation:code>
< The reference details for the link.; (xsd)url:uri>🔗 An ExtensionBillingSummary(xsd)(doc)=
<#base:Extension>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< An Extension; (xsd)extension: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. http://hl7.org/fhir/uv/order-catalog/StructureDefinition/BillingSummary; (xsd)url:string>
(<valueMarkdown:markdown>
|<valueString:string>){0,0}
< Summarizes in a human-readable manner the billing, claims and reimbursement dispositions defined for the laboratory service defined by the PlanDefinition; (xsd)textualSummary:BillingSummary.textualSummary>?
[]< code summarizing the reimbursability of the laboratory service; (xsd)reimbursabilitySummary:BillingSummary.reimbursabilitySummary>*🔗 code summarizing the reimbursability of the laboratory serviceBillingSummary.reimbursabilitySummary(xsd)(doc)=
<#base:Extension>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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. reimbursabilitySummary; (xsd)url:string>
< Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R5/extensibility.html) for a list). Binding: laboratory-service-reimbursability-vs (extensible, Coarse categories of reimbursement dispositions for a laboratory service); (xsd)value:code>?🔗 Summarizes in a human-readable manner the billing, claims and reimbursement dispositions defined for the laboratory service defined by the PlanDefinitionBillingSummary.textualSummary(xsd)(doc)=
<#base:Extension>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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. textualSummary; (xsd)url:string>
< Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R5/extensibility.html) for a list).; (xsd)value:markdown>?🔗 A resource that represents the data of a single raw artifact as digital content accessible in its native format. A Binary resource can contain any content, whether text, image, pdf, zip archive, etc. Typically, Binary resources are used for handling content such as:
* CDA Documents (i.e. with XDS)
* PDF Documents
* Images.Binary(xsd)(doc)=
<#base:Resource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< MimeType of the binary content represented as a standard MimeType (BCP 13). Binding: mimetypes (required, The mime type of an attachment. Any valid mime type is allowed.); (xsd)contentType:code>
< This element identifies another resource that can be used as a proxy of the security sensitivity to use when deciding and enforcing access control rules for the Binary resource. Given that the Binary resource contains very few elements that can be used to determine the sensitivity of the data and relationships to individuals, the referenced resource stands in as a proxy equivalent for this purpose. This referenced resource may be related to the Binary (e.g. DocumentReference), or may be some non-related Resource purely as a security proxy. E.g. to identify that the binary resource relates to a patient, and access should only be granted to applications that have access to the patient. Very often, a server will also know of a resource that references the binary, and can automatically apply the appropriate access rules based on that reference. However, there are some circumstances where this is not appropriate, e.g. the binary is uploaded directly to the server without any linking resource, the binary is referred to from multiple different resources, and/or the binary is content such as an application logo that has less protection than any of the resources that reference it.; (xsd)securityContext:Resource*>?
< The actual content, base64 encoded. If the content type is itself base64 encoding, then this will be base64 encoded twice - what is created by un-base64ing the content must be the specified content type.; (xsd)data:base64Binary>?🔗 This resource reflects an instance of a biologically derived product. A material substance originating from a biological entity intended to be transplanted or infused
into another (possibly the same) biological entity. Substances include, but are not limited to: whole blood, bone marrow, organs, and manipulated blood cells.BiologicallyDerivedProduct(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< Broad category of this product. Binding: product-category (example, Biologically Derived Product Category.); (xsd)productCategory:Coding>?
< A codified value that systematically supports characterization and classification of medical products of human origin inclusive of processing conditions such as additives, volumes and handling conditions. Binding: biologicallyderived-productcodes (example, Biologically-derived Product Codes); (xsd)productCode:CodeableConcept>?
[]< Parent product (if any) for this biologically-derived product. For products that have multiple collections. For example Peripheral Blood Stem Cells may be collected over several days from a single donor and the donation split into in multiple containers which must be linked to the parent donation.; (xsd)parent:BiologicallyDerivedProduct*>*
[]< Request to obtain and/or infuse this biologically derived product.; (xsd)request:ServiceRequest*>*
[]< Unique instance identifiers assigned to a biologically derived product. Note: This is a business identifier, not a resource identifier. This identifier should uniquely identify the product instance in the business domain. Ideally it should be a globally unique identifier under the control of an ISO/IEC 15459 Issuing Agency.; (xsd)identifier:Identifier>*
< An identifier that supports traceability to the event during which material in this product from one or more biological entities was obtained or pooled. Necessary to support mandatory requirements for traceability from donor/source to recipient and vice versa, while also satisfying donor anonymity requirements. The element is defined consistently across BiologicallyDerivedProduct, NutritionProduct, and Device. The identifier references an event that links to a single biological entity such as a blood donor, or to multiple biological entities (e.g. when the product is an embryo or a pooled platelet product). A single biologicalSourceEvent identifier may appear on multiple products of many types derived from a single donation event or source extraction. As an example, a single donation event may provide 2 kidneys and a liver for organ transplantation, 2 corneas for eye surgery, heart valves and arterial tissue for cardiovascular surgery, multiple skin grafts, tendons, multiple shaped bone grafts and a large number of bone putty/paste products; and each of them may be assigned to the same biological source event identifier.; (xsd)biologicalSourceEvent:Identifier>?
[]< Processing facilities responsible for the labeling and distribution of this biologically derived product.; (xsd)processingFacility:Organization*>*
< A unique identifier for an aliquot of a product. Used to distinguish individual aliquots of a product carrying the same biologicalSource and productCode identifiers.; (xsd)division:string>?
< Whether the product is currently available. Binding: biologicallyderived-product-status (example, Biologically Derived Product Status.); (xsd)productStatus:Coding>?
< Date, and where relevant time, of expiration.; (xsd)expirationDate:dateTime>?
< How this product was collected.; (xsd)collection:BiologicallyDerivedProduct.collection>?
< The temperature requirements for storage of the biologically-derived product. May be extracted from information held in the Product Description Code.; (xsd)storageTempRequirements:Range>?
[]< A property that is specific to this BiologicallyDerviedProduct instance. Property can be used to provide information on a wide range of additional information specific to a particular biologicallyDerivedProduct.; (xsd)property:BiologicallyDerivedProduct.property>*🔗 How this product was collected.BiologicallyDerivedProduct.collection(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Healthcare professional who is performing the collection.; (xsd)collector:(<Practitioner>
|<PractitionerRole>)>?
< The patient or entity, such as a hospital or vendor in the case of a processed/manipulated/manufactured product, providing the product.; (xsd)source:(<Organization>
|<Patient>)>?
< Time of product collection.; (xsd)collected:(<dateTime>
|<Period>)>?🔗 A property that is specific to this BiologicallyDerviedProduct instance. Property can be used to provide information on a wide range of additional information specific to a particular biologicallyDerivedProduct.BiologicallyDerivedProduct.property(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Code that specifies the property. It should reference an established coding system. The element is identified by name and system URI in the type. Some types may have multiple occurrences. Binding: biologicallyderived-product-property-type-codes (example, Biologically Derived Product Property Type Codes); (xsd)type:CodeableConcept>
(<valueAttachment:Attachment>
|<valueBoolean:boolean>
|<valueCodeableConcept:CodeableConcept>
|<valueInteger:integer>
|<valuePeriod:Period>
|<valueQuantity:Quantity>
|<valueRange:Range>
|<valueRatio:Ratio>
|<valueString:string>)🔗 This resource reflects an instance of a biologically derived product dispense. The supply or dispense of a biologically derived product from the supply organization or department (e.g. hospital transfusion laboratory) to the clinical team responsible for clinical application.BiologicallyDerivedProductDispense(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< Unique instance identifiers assigned to a biologically derived product dispense. Note: This is a business identifier, not a resource identifier.; (xsd)identifier:Identifier>*
[]< The order or request that the dispense is fulfilling. This is a reference to a ServiceRequest resource.; (xsd)basedOn:ServiceRequest*>*
[]< A larger event of which this particular event is a component.; (xsd)partOf:BiologicallyDerivedProductDispense*>*
< A code specifying the state of the dispense event. Binding: biologicallyderivedproductdispense-status (required, Describes the lifecycle of the dispense.); (xsd)status:code>
< Indicates the relationship between the donor of the biologically derived product and the intended recipient. Binding: biologicallyderivedproductdispense-origin-relationship (example, Describes the relationship between the recipient and origin of the dispensed product.); (xsd)originRelationshipType:CodeableConcept>?
< A link to a resource identifying the biologically derived product that is being dispensed.; (xsd)product:BiologicallyDerivedProduct*>
< A link to a resource representing the patient that the product is dispensed for.; (xsd)patient:Patient*>
< Indicates the type of matching associated with the dispense. Binding: biologicallyderivedproductdispense-match-status (example, Describes the type of matching between the recipient and origin of the dispensed product.); (xsd)matchStatus:CodeableConcept>?
[]< Indicates who or what performed an action.; (xsd)performer:BiologicallyDerivedProductDispense.performer>*
< The physical location where the dispense was performed.; (xsd)location:Location*>?
< The amount of product in the dispense. Quantity will depend on the product being dispensed. Examples are: volume; cell count; concentration.; (xsd)quantity:SimpleQuantity>?
< When the product was selected/ matched.; (xsd)preparedDate:dateTime>?
< When the product was dispatched for clinical use.; (xsd)whenHandedOver:dateTime>?
< Link to a resource identifying the physical location that the product was dispatched to.; (xsd)destination:Location*>?
[]< Additional notes.; (xsd)note:Annotation>*
< Specific instructions for use.; (xsd)usageInstruction:string>?🔗 Indicates who or what performed an action.BiologicallyDerivedProductDispense.performer(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Identifies the function of the performer during the dispense. Binding: biologicallyderivedproductdispense-performer-function (example, Describes the the role or function of the performer in the dispense.); (xsd)function:CodeableConcept>?
< Identifies the person responsible for the action.; (xsd)actor:Practitioner*>🔗 This profile defines how to represent Body Mass Index (BMI) observations in FHIR using a standard LOINC code and UCUM units of measure. Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as laboratory reports, etc.bmi(xsd)(doc)=
<#base:vitalsigns>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< A unique identifier assigned to this observation.; (xsd)identifier:Identifier>*
< The reference to a FHIR ObservationDefinition resource that provides the definition that is adhered to in whole or in part by this Observation instance. ObservationDefinition can be referenced by its canonical url using instantiatesCanonical, or by a name or an identifier using the appropriate sub-elements of instantiatesReference.; (xsd)instantiates:ObservationDefinition*>?
[]< A plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed.; (xsd)basedOn:(<CarePlan>
|<DeviceRequest>
|<ImmunizationRecommendation>
|<MedicationRequest>
|<NutritionOrder>
|<ServiceRequest>)>*
[]< Identifies the observation(s) that triggered the performance of this observation.; (xsd)triggeredBy:bmi.triggeredBy>*
[]< A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure. To link an Observation to an Encounter use `encounter`. See the [Notes](observation.html#obsgrouping) below for guidance on referencing another Observation.; (xsd)partOf:(<GenomicStudy>
|<ImagingStudy>
|<Immunization>
|<MedicationAdministration>
|<MedicationDispense>
|<MedicationStatement>
|<Procedure>)>*
< The status of the result value. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. Binding: observation-status (required, ); (xsd)status:code>
[]< A code that classifies the general type of observation being made. In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set. Binding: observation-category (preferred, Codes for high level observation categories.); (xsd)category:CodeableConcept>+
< Body Mass Index (BMI). additional codes that translate or map to this code are allowed. For example a more granular LOINC code or code that is used locally in a system. Binding: observation-vitalsignresult (extensible, This identifies the vital sign result type. Original source C-CDA R1.1 , HITSP Vital Sign Result Type.); (xsd)code:bmi.code>
< The patient, or group of patients, location, device, organization, procedure or practitioner this observation is about and into whose or what record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the `focus` element or the `code` itself specifies the actual focus of the observation. One would expect this element to be a cardinality of 1..1. The only circumstance in which the subject can be missing is when the observation is made by a device that does not know the patient. In this case, the observation SHALL be matched to a patient through some context/channel matching technique, and at this point, the observation should be updated. The subject of an Observation may in some cases be a procedure. This supports the regulatory inspection use case where observations are captured during inspections of a procedure that is being performed (independent of any particular patient or whether patient related at all).; (xsd)subject:Patient*>
[]< The actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also be an existing condition, an intervention, the subject's diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child's tracheostomy tube. In this example, the child is the patient of record and the mother is the focus. Typically, an observation is made about the subject - a patient, or group of patients, location, or device - and the distinction between the subject and what is directly measured for an observation is specified in the observation code itself ( e.g., "Blood Glucose") and does not need to be represented separately using this element. Use `specimen` if a reference to a specimen is required. If a code is required instead of a resource use either `bodysite` for bodysites or the standard extension [http://hl7.org/fhir/StructureDefinition/observation-focusCode](http://hl7.org/fhir/extensions/StructureDefinition-observation-focusCode.html).; (xsd)focus:Resource*>*
< The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made. This will typically be the encounter the event occurred within, but some events may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission laboratory tests).; (xsd)encounter:Encounter*>?
< Often just a dateTime for Vital Signs. At least a date should be present unless this observation is a historical report. For recording imprecise or "fuzzy" times (For example, a blood glucose measurement taken "after breakfast") use the [Timing](datatypes.html#timing) datatype which allow the measurement to be tied to regular life events.; (xsd)effective:(<dateTime>
|<Period>)>
< The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified. For Observations that don't require review and verification, it may be the same as the [`lastUpdated` ](resource-definitions.html#Meta.lastUpdated) time of the resource itself. For Observations that do require review and verification for certain updates, it might not be the same as the `lastUpdated` time of the resource itself due to a non-clinically significant update that doesn't require the new version to be reviewed and verified again.; (xsd)issued:instant>?
[]< Who was responsible for asserting the observed value as "true".; (xsd)performer:(<CareTeam>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>*
< Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept. - An observation may have:
1. a single value here
1. both a value and a set of related or component values
1. only a set of related or component values.
- If a value is present, the datatype for this element should be determined by the `code`.
- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.
- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.
- The usage of valueReference is restricted to the MolecularSequence resource when used as a definitional resource, not as a patient-specific finding. .
- For additional guidance, see the [Notes section](observation.html#notes) below.; (xsd)value:Quantity>
< Provides a reason why the expected value in the element Observation.value[x] is missing. Null or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be "detected", "not detected", "inconclusive", or "specimen unsatisfactory".
The alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code "error" could be used when the measurement was not completed. Note that an observation may only be reported if there are values to report. For example differential cell counts values may be reported only when > 0. Because of these options, use-case agreements are required to interpret general observations for null or exceptional values. Binding: data-absent-reason (extensible, Codes specifying why the result (`Observation.value[x]`) is missing.); (xsd)dataAbsentReason:CodeableConcept>?
[]< A categorical assessment of an observation value. For example, high, low, normal. Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Binding: observation-interpretation (extensible, Codes identifying interpretations of observations.); (xsd)interpretation:CodeableConcept>*
[]< Comments about the observation or the results. May include general statements about the observation, or statements about significant, unexpected or unreliable results values, or information about its source when relevant to its interpretation.; (xsd)note:Annotation>*
< Indicates the site on the subject's body where the observation was made (i.e. the target site). Only used if not implicit in code found in Observation.code. In many systems, this may be represented as a related observation instead of an inline component. Binding: body-site (example, SNOMED CT Body site concepts); (xsd)bodySite:CodeableConcept>?
< Indicates the body structure on the subject's body where the observation was made (i.e. the target site). Only used if not implicit in code found in Observation.code or bodySite is used. In many systems, this may be represented as a related observation instead of an inline component.; (xsd)bodyStructure:BodyStructure*>?
< Indicates the mechanism used to perform the observation. Only used if not implicit in code for Observation.code. Binding: observation-methods (example, Methods for simple observations.); (xsd)method:CodeableConcept>?
< The specimen that was used when this observation was made. Should only be used if not implicit in code found in `Observation.code`. Observations are not made on specimens themselves; they are made on a subject, but in many cases by the means of a specimen. Note that although specimens are often involved, they are not always tracked and reported explicitly. Also note that observation resources may be used in contexts that track the specimen explicitly (e.g. Diagnostic Report).; (xsd)specimen:(<Group>
|<Specimen>)>?
< A reference to the device that generates the measurements or the device settings for the device. Note that this is not meant to represent a device involved in the transmission of the result, e.g., a gateway. Such devices may be documented using the Provenance resource where relevant.; (xsd)device:(<Device>
|<DeviceMetric>)>?
[]< Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an "OR". In other words, to represent two distinct target populations, two `referenceRange` elements would be used. Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.; (xsd)referenceRange:bmi.referenceRange>*
[]< Used when reporting vital signs panel components. When using this element, an observation will typically have either a value or a set of related resources, although both may be present in some cases. For a discussion on the ways Observations can assembled in groups together, see [Notes](observation.html#obsgrouping) below. Note that a system may calculate results from [QuestionnaireResponse](questionnaireresponse.html) into a final score and represent the score as an Observation.; (xsd)hasMember:(<MolecularSequence>
|<QuestionnaireResponse>
|<vitalsigns>)>*
[]< The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image. All the reference choices that are listed in this element can represent clinical observations and other measurements that may be the source for a derived value. The most common reference will be another Observation. For a discussion on the ways Observations can assembled in groups together, see [Notes](observation.html#obsgrouping) below.; (xsd)derivedFrom:(<DocumentReference>
|<ImagingStudy>
|<MolecularSequence>
|<QuestionnaireResponse>
|<vitalsigns>)>*
[]< Used when reporting systolic and diastolic blood pressure. For a discussion on the ways Observations can be assembled in groups together see [Notes](observation.html#notes) below.; (xsd)component:bmi.component>*
< A code that classifies the general type of observation being made. In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set. Binding: observation-category (preferred, Codes for high level observation categories.); (xsd)VSCat:bmi.VSCat>
< Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept. - An observation may have:
1. a single value here
1. both a value and a set of related or component values
1. only a set of related or component values.
- If a value is present, the datatype for this element should be determined by the `code`.
- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.
- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.
- The usage of valueReference is restricted to the MolecularSequence resource when used as a definitional resource, not as a patient-specific finding. .
- For additional guidance, see the [Notes section](observation.html#notes) below.; (xsd)valueQuantity:bmi.valueQuantity>🔗 Body Mass Index (BMI). additional codes that translate or map to this code are allowed. For example a more granular LOINC code or code that is used locally in a system. Binding: observation-vitalsignresult (extensible, This identifies the vital sign result type. Original source C-CDA R1.1 , HITSP Vital Sign Result Type.)bmi.code(xsd)(doc)=
<#base:CodeableConcept>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< 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.; (xsd)coding:Coding>*
< 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.; (xsd)text:string>?
< 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.; (xsd)BMICode:bmi.code.BMICode>🔗 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.bmi.code.BMICode(xsd)(doc)=
<#base:Coding>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< 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 be an absolute reference to some definition that establishes the system clearly and unambiguously. http://loinc.org; (xsd)system:uri>
< 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.; (xsd)version:string>?
< 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). 39156-5; (xsd)code>
< A representation of the meaning of the code in the system, following the rules of the system.; (xsd)display:string>?
< 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.; (xsd)userSelected:boolean>?🔗 Used when reporting systolic and diastolic blood pressure. For a discussion on the ways Observations can be assembled in groups together see [Notes](observation.html#notes) below.bmi.component(xsd)(doc)=
<#base:Observation.component>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Describes what was observed. Sometimes this is called the observation "code". *All* code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. Binding: observation-vitalsignresult (extensible, This identifies the vital sign result type. Original source C-CDA R1.1 , HITSP Vital Sign Result Type.); (xsd)code:CodeableConcept>
(<valueAttachment:Attachment>
|<valueBoolean:boolean>
|<valueCodeableConcept:CodeableConcept>
|<valueDateTime:dateTime>
|<valueInteger:integer>
|<valueMolecularSequence:MolecularSequence>
|<valuePeriod:Period>
|<valueQuantity:Quantity>
|<valueRange:Range>
|<valueRatio:Ratio>
|<valueSampledData:SampledData>
|<valueString:string>
|<valueTime:time>)?
< Provides a reason why the expected value in the element Observation.component.value[x] is missing. "Null" or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be "detected", "not detected", "inconclusive", or "test not done".
The alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code "error" could be used when the measurement was not completed. Because of these options, use-case agreements are required to interpret general observations for exceptional values. Binding: data-absent-reason (extensible, Codes specifying why the result (`Observation.value[x]`) is missing.); (xsd)dataAbsentReason:CodeableConcept>?
[]< A categorical assessment of an observation value. For example, high, low, normal. Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Binding: observation-interpretation (extensible, Codes identifying interpretations of observations.); (xsd)interpretation:CodeableConcept>*
[]< Guidance on how to interpret the value by comparison to a normal or recommended range. Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.; (xsd)referenceRange:Observation.referenceRange>*
< Vital Sign Value recorded with UCUM. Used when observation has a set of component observations:
- An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was derived).
- If a value is present, the datatype for this element should be determined by the `code`.
- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.
- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.
- If a value is present, the datatype for this element should be determined by the `code`.
- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.
- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.
- The usage of valueReference is restricted to the MolecularSequence resource when used as a definitional resource, not as a patient-specific finding. .
- For additional guidance, see the [Notes section](observation.html#notes) below. Binding: ucum-vitals-common (required, Commonly encountered UCUM units for recording Vital Signs.); (xsd)valueQuantity:Quantity>?🔗 Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an "OR". In other words, to represent two distinct target populations, two `referenceRange` elements would be used. Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.bmi.referenceRange(xsd)(doc)=
<#base:Observation.referenceRange>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The value of the low bound of the reference range. The low bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the low bound is omitted, it is assumed to be meaningless (e.g. reference range is <=2.3).; (xsd)low:SimpleQuantity>?
< The value of the high bound of the reference range. The high bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the high bound is omitted, it is assumed to be meaningless (e.g. reference range is >= 2.3).; (xsd)high:SimpleQuantity>?
< The value of the normal value of the reference range. Binding: observation-referencerange-normalvalue (extensible, Codes identifying the normal value of the observation.); (xsd)normalValue:CodeableConcept>?
< Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range. This SHOULD be populated if there is more than one range. If this element is not present then the normal range is assumed. Binding: referencerange-meaning (preferred, Code for the meaning of a reference range.); (xsd)type:CodeableConcept>?
[]< Codes to indicate the target population this reference range applies to. For example, a reference range may be based on the normal population or a particular sex or race. Multiple `appliesTo` are interpreted as an "AND" of the target populations. For example, to represent a target population of African American females, both a code of female and a code for African American would be used. This SHOULD be populated if there is more than one range. If this element is not present then the normal population is assumed. Binding: referencerange-appliesto (example, Codes identifying the population the reference range applies to.); (xsd)appliesTo:CodeableConcept>*
< The age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so.; (xsd)age:Range>?
< Text based reference range in an observation which may be used when a quantitative range is not appropriate for an observation. An example would be a reference value of "Negative" or a list or table of "normals".; (xsd)text:markdown>?🔗 Identifies the observation(s) that triggered the performance of this observation.bmi.triggeredBy(xsd)(doc)=
<#base:Observation.triggeredBy>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Reference to the triggering observation.; (xsd)observation:Observation*>
< The type of trigger.
Reflex | Repeat | Re-run. Binding: observation-triggeredbytype (required, The type of TriggeredBy Observation.); (xsd)type:code>
< Provides the reason why this observation was performed as a result of the observation(s) referenced.; (xsd)reason:string>?🔗 Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept. - An observation may have:
1. a single value here
1. both a value and a set of related or component values
1. only a set of related or component values.
- If a value is present, the datatype for this element should be determined by the `code`.
- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.
- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.
- The usage of valueReference is restricted to the MolecularSequence resource when used as a definitional resource, not as a patient-specific finding. .
- For additional guidance, see the [Notes section](observation.html#notes) below.bmi.valueQuantity(xsd)(doc)=
<#base:Quantity>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< 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).; (xsd)value:decimal>
< 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. Binding: quantity-comparator (required, How the Quantity should be understood and represented.); (xsd)comparator:code>?
< A human-readable form of the unit.; (xsd)unit:string>
< The identification of the system that provides the coded form of the unit. http://unitsofmeasure.org; (xsd)system:uri>
< Coded responses from the common UCUM units for vital signs value set. 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. kg/m2; (xsd)code>🔗 A code that classifies the general type of observation being made. In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set. Binding: observation-category (preferred, Codes for high level observation categories.)bmi.VSCat(xsd)(doc)=
<#base:vitalsigns.VSCat>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< 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.; (xsd)coding:bmi.VSCat.coding>+
< 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.; (xsd)text:string>?🔗 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.bmi.VSCat.coding(xsd)(doc)=
<#base:vitalsigns.VSCat.coding>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< 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 be an absolute reference to some definition that establishes the system clearly and unambiguously. http://terminology.hl7.org/CodeSystem/observation-category; (xsd)system:uri>
< 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.; (xsd)version:string>?
< 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). vital-signs; (xsd)code>
< A representation of the meaning of the code in the system, following the rules of the system.; (xsd)display:string>?
< 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.; (xsd)userSelected:boolean>?🔗 This profile defines how to represent Body Height observations in FHIR using a standard LOINC code and UCUM units of measure. Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as laboratory reports, etc.bodyheight(xsd)(doc)=
<#base:vitalsigns>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< A unique identifier assigned to this observation.; (xsd)identifier:Identifier>*
< The reference to a FHIR ObservationDefinition resource that provides the definition that is adhered to in whole or in part by this Observation instance. ObservationDefinition can be referenced by its canonical url using instantiatesCanonical, or by a name or an identifier using the appropriate sub-elements of instantiatesReference.; (xsd)instantiates:ObservationDefinition*>?
[]< A plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed.; (xsd)basedOn:(<CarePlan>
|<DeviceRequest>
|<ImmunizationRecommendation>
|<MedicationRequest>
|<NutritionOrder>
|<ServiceRequest>)>*
[]< Identifies the observation(s) that triggered the performance of this observation.; (xsd)triggeredBy:bodyheight.triggeredBy>*
[]< A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure. To link an Observation to an Encounter use `encounter`. See the [Notes](observation.html#obsgrouping) below for guidance on referencing another Observation.; (xsd)partOf:(<GenomicStudy>
|<ImagingStudy>
|<Immunization>
|<MedicationAdministration>
|<MedicationDispense>
|<MedicationStatement>
|<Procedure>)>*
< The status of the result value. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. Binding: observation-status (required, ); (xsd)status:code>
[]< A code that classifies the general type of observation being made. In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set. Binding: observation-category (preferred, Codes for high level observation categories.); (xsd)category:CodeableConcept>+
< Body Height. additional codes that translate or map to this code are allowed. For example a more granular LOINC code or code that is used locally in a system. Binding: observation-vitalsignresult (extensible, This identifies the vital sign result type. Original source C-CDA R1.1 , HITSP Vital Sign Result Type.); (xsd)code:bodyheight.code>
< The patient, or group of patients, location, device, organization, procedure or practitioner this observation is about and into whose or what record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the `focus` element or the `code` itself specifies the actual focus of the observation. One would expect this element to be a cardinality of 1..1. The only circumstance in which the subject can be missing is when the observation is made by a device that does not know the patient. In this case, the observation SHALL be matched to a patient through some context/channel matching technique, and at this point, the observation should be updated. The subject of an Observation may in some cases be a procedure. This supports the regulatory inspection use case where observations are captured during inspections of a procedure that is being performed (independent of any particular patient or whether patient related at all).; (xsd)subject:Patient*>
[]< The actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also be an existing condition, an intervention, the subject's diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child's tracheostomy tube. In this example, the child is the patient of record and the mother is the focus. Typically, an observation is made about the subject - a patient, or group of patients, location, or device - and the distinction between the subject and what is directly measured for an observation is specified in the observation code itself ( e.g., "Blood Glucose") and does not need to be represented separately using this element. Use `specimen` if a reference to a specimen is required. If a code is required instead of a resource use either `bodysite` for bodysites or the standard extension [http://hl7.org/fhir/StructureDefinition/observation-focusCode](http://hl7.org/fhir/extensions/StructureDefinition-observation-focusCode.html).; (xsd)focus:Resource*>*
< The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made. This will typically be the encounter the event occurred within, but some events may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission laboratory tests).; (xsd)encounter:Encounter*>?
< Often just a dateTime for Vital Signs. At least a date should be present unless this observation is a historical report. For recording imprecise or "fuzzy" times (For example, a blood glucose measurement taken "after breakfast") use the [Timing](datatypes.html#timing) datatype which allow the measurement to be tied to regular life events.; (xsd)effective:(<dateTime>
|<Period>)>
< The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified. For Observations that don't require review and verification, it may be the same as the [`lastUpdated` ](resource-definitions.html#Meta.lastUpdated) time of the resource itself. For Observations that do require review and verification for certain updates, it might not be the same as the `lastUpdated` time of the resource itself due to a non-clinically significant update that doesn't require the new version to be reviewed and verified again.; (xsd)issued:instant>?
[]< Who was responsible for asserting the observed value as "true".; (xsd)performer:(<CareTeam>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>*
(<valueAttachment:Attachment>
|<valueBoolean:boolean>
|<valueCodeableConcept:CodeableConcept>
|<valueDateTime:dateTime>
|<valueInteger:integer>
|<valueMolecularSequence:MolecularSequence>
|<valuePeriod:Period>
|<valueQuantity:Quantity>
|<valueRange:Range>
|<valueRatio:Ratio>
|<valueSampledData:SampledData>
|<valueString:string>
|<valueTime:time>)?
< Provides a reason why the expected value in the element Observation.value[x] is missing. Null or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be "detected", "not detected", "inconclusive", or "specimen unsatisfactory".
The alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code "error" could be used when the measurement was not completed. Note that an observation may only be reported if there are values to report. For example differential cell counts values may be reported only when > 0. Because of these options, use-case agreements are required to interpret general observations for null or exceptional values. Binding: data-absent-reason (extensible, Codes specifying why the result (`Observation.value[x]`) is missing.); (xsd)dataAbsentReason:CodeableConcept>?
[]< A categorical assessment of an observation value. For example, high, low, normal. Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Binding: observation-interpretation (extensible, Codes identifying interpretations of observations.); (xsd)interpretation:CodeableConcept>*
[]< Comments about the observation or the results. May include general statements about the observation, or statements about significant, unexpected or unreliable results values, or information about its source when relevant to its interpretation.; (xsd)note:Annotation>*
< Indicates the site on the subject's body where the observation was made (i.e. the target site). Only used if not implicit in code found in Observation.code. In many systems, this may be represented as a related observation instead of an inline component. Binding: body-site (example, SNOMED CT Body site concepts); (xsd)bodySite:CodeableConcept>?
< Indicates the body structure on the subject's body where the observation was made (i.e. the target site). Only used if not implicit in code found in Observation.code or bodySite is used. In many systems, this may be represented as a related observation instead of an inline component.; (xsd)bodyStructure:BodyStructure*>?
< Indicates the mechanism used to perform the observation. Only used if not implicit in code for Observation.code. Binding: observation-methods (example, Methods for simple observations.); (xsd)method:CodeableConcept>?
< The specimen that was used when this observation was made. Should only be used if not implicit in code found in `Observation.code`. Observations are not made on specimens themselves; they are made on a subject, but in many cases by the means of a specimen. Note that although specimens are often involved, they are not always tracked and reported explicitly. Also note that observation resources may be used in contexts that track the specimen explicitly (e.g. Diagnostic Report).; (xsd)specimen:(<Group>
|<Specimen>)>?
< A reference to the device that generates the measurements or the device settings for the device. Note that this is not meant to represent a device involved in the transmission of the result, e.g., a gateway. Such devices may be documented using the Provenance resource where relevant.; (xsd)device:(<Device>
|<DeviceMetric>)>?
[]< Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an "OR". In other words, to represent two distinct target populations, two `referenceRange` elements would be used. Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.; (xsd)referenceRange:bodyheight.referenceRange>*
[]< Used when reporting vital signs panel components. When using this element, an observation will typically have either a value or a set of related resources, although both may be present in some cases. For a discussion on the ways Observations can assembled in groups together, see [Notes](observation.html#obsgrouping) below. Note that a system may calculate results from [QuestionnaireResponse](questionnaireresponse.html) into a final score and represent the score as an Observation.; (xsd)hasMember:(<MolecularSequence>
|<QuestionnaireResponse>
|<vitalsigns>)>*
[]< The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image. All the reference choices that are listed in this element can represent clinical observations and other measurements that may be the source for a derived value. The most common reference will be another Observation. For a discussion on the ways Observations can assembled in groups together, see [Notes](observation.html#obsgrouping) below.; (xsd)derivedFrom:(<DocumentReference>
|<ImagingStudy>
|<MolecularSequence>
|<QuestionnaireResponse>
|<vitalsigns>)>*
[]< Used when reporting systolic and diastolic blood pressure. For a discussion on the ways Observations can be assembled in groups together see [Notes](observation.html#notes) below.; (xsd)component:bodyheight.component>*
< A code that classifies the general type of observation being made. In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set. Binding: observation-category (preferred, Codes for high level observation categories.); (xsd)VSCat:bodyheight.VSCat>
< Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept. - An observation may have:
1. a single value here
1. both a value and a set of related or component values
1. only a set of related or component values.
- If a value is present, the datatype for this element should be determined by the `code`.
- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.
- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.
- The usage of valueReference is restricted to the MolecularSequence resource when used as a definitional resource, not as a patient-specific finding. .
- For additional guidance, see the [Notes section](observation.html#notes) below.; (xsd)valueQuantity:bodyheight.valueQuantity>?🔗 Body Height. additional codes that translate or map to this code are allowed. For example a more granular LOINC code or code that is used locally in a system. Binding: observation-vitalsignresult (extensible, This identifies the vital sign result type. Original source C-CDA R1.1 , HITSP Vital Sign Result Type.)bodyheight.code(xsd)(doc)=
<#base:CodeableConcept>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< 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.; (xsd)coding:Coding>*
< 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.; (xsd)text:string>?
< 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.; (xsd)BodyHeightCode:bodyheight.code.BodyHeightCode>🔗 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.bodyheight.code.BodyHeightCode(xsd)(doc)=
<#base:Coding>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< 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 be an absolute reference to some definition that establishes the system clearly and unambiguously. http://loinc.org; (xsd)system:uri>
< 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.; (xsd)version:string>?
< 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). 8302-2; (xsd)code>
< A representation of the meaning of the code in the system, following the rules of the system.; (xsd)display:string>?
< 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.; (xsd)userSelected:boolean>?🔗 Used when reporting systolic and diastolic blood pressure. For a discussion on the ways Observations can be assembled in groups together see [Notes](observation.html#notes) below.bodyheight.component(xsd)(doc)=
<#base:Observation.component>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Describes what was observed. Sometimes this is called the observation "code". *All* code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. Binding: observation-vitalsignresult (extensible, This identifies the vital sign result type. Original source C-CDA R1.1 , HITSP Vital Sign Result Type.); (xsd)code:CodeableConcept>
(<valueAttachment:Attachment>
|<valueBoolean:boolean>
|<valueCodeableConcept:CodeableConcept>
|<valueDateTime:dateTime>
|<valueInteger:integer>
|<valueMolecularSequence:MolecularSequence>
|<valuePeriod:Period>
|<valueQuantity:Quantity>
|<valueRange:Range>
|<valueRatio:Ratio>
|<valueSampledData:SampledData>
|<valueString:string>
|<valueTime:time>)?
< Provides a reason why the expected value in the element Observation.component.value[x] is missing. "Null" or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be "detected", "not detected", "inconclusive", or "test not done".
The alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code "error" could be used when the measurement was not completed. Because of these options, use-case agreements are required to interpret general observations for exceptional values. Binding: data-absent-reason (extensible, Codes specifying why the result (`Observation.value[x]`) is missing.); (xsd)dataAbsentReason:CodeableConcept>?
[]< A categorical assessment of an observation value. For example, high, low, normal. Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Binding: observation-interpretation (extensible, Codes identifying interpretations of observations.); (xsd)interpretation:CodeableConcept>*
[]< Guidance on how to interpret the value by comparison to a normal or recommended range. Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.; (xsd)referenceRange:Observation.referenceRange>*
< Vital Sign Value recorded with UCUM. Used when observation has a set of component observations:
- An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was derived).
- If a value is present, the datatype for this element should be determined by the `code`.
- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.
- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.
- If a value is present, the datatype for this element should be determined by the `code`.
- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.
- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.
- The usage of valueReference is restricted to the MolecularSequence resource when used as a definitional resource, not as a patient-specific finding. .
- For additional guidance, see the [Notes section](observation.html#notes) below. Binding: ucum-vitals-common (required, Commonly encountered UCUM units for recording Vital Signs.); (xsd)valueQuantity:Quantity>?🔗 Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an "OR". In other words, to represent two distinct target populations, two `referenceRange` elements would be used. Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.bodyheight.referenceRange(xsd)(doc)=
<#base:Observation.referenceRange>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The value of the low bound of the reference range. The low bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the low bound is omitted, it is assumed to be meaningless (e.g. reference range is <=2.3).; (xsd)low:SimpleQuantity>?
< The value of the high bound of the reference range. The high bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the high bound is omitted, it is assumed to be meaningless (e.g. reference range is >= 2.3).; (xsd)high:SimpleQuantity>?
< The value of the normal value of the reference range. Binding: observation-referencerange-normalvalue (extensible, Codes identifying the normal value of the observation.); (xsd)normalValue:CodeableConcept>?
< Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range. This SHOULD be populated if there is more than one range. If this element is not present then the normal range is assumed. Binding: referencerange-meaning (preferred, Code for the meaning of a reference range.); (xsd)type:CodeableConcept>?
[]< Codes to indicate the target population this reference range applies to. For example, a reference range may be based on the normal population or a particular sex or race. Multiple `appliesTo` are interpreted as an "AND" of the target populations. For example, to represent a target population of African American females, both a code of female and a code for African American would be used. This SHOULD be populated if there is more than one range. If this element is not present then the normal population is assumed. Binding: referencerange-appliesto (example, Codes identifying the population the reference range applies to.); (xsd)appliesTo:CodeableConcept>*
< The age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so.; (xsd)age:Range>?
< Text based reference range in an observation which may be used when a quantitative range is not appropriate for an observation. An example would be a reference value of "Negative" or a list or table of "normals".; (xsd)text:markdown>?🔗 Identifies the observation(s) that triggered the performance of this observation.bodyheight.triggeredBy(xsd)(doc)=
<#base:Observation.triggeredBy>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Reference to the triggering observation.; (xsd)observation:Observation*>
< The type of trigger.
Reflex | Repeat | Re-run. Binding: observation-triggeredbytype (required, The type of TriggeredBy Observation.); (xsd)type:code>
< Provides the reason why this observation was performed as a result of the observation(s) referenced.; (xsd)reason:string>?🔗 Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept. - An observation may have:
1. a single value here
1. both a value and a set of related or component values
1. only a set of related or component values.
- If a value is present, the datatype for this element should be determined by the `code`.
- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.
- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.
- The usage of valueReference is restricted to the MolecularSequence resource when used as a definitional resource, not as a patient-specific finding. .
- For additional guidance, see the [Notes section](observation.html#notes) below.bodyheight.valueQuantity(xsd)(doc)=
<#base:Quantity>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< 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).; (xsd)value:decimal>
< 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. Binding: quantity-comparator (required, How the Quantity should be understood and represented.); (xsd)comparator:code>?
< A human-readable form of the unit.; (xsd)unit:string>
< The identification of the system that provides the coded form of the unit. http://unitsofmeasure.org; (xsd)system:uri>
< Coded responses from the common UCUM units for vital signs value set. 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. Binding: ucum-bodylength (required, cm | [in_i]); (xsd)code>🔗 A code that classifies the general type of observation being made. In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set. Binding: observation-category (preferred, Codes for high level observation categories.)bodyheight.VSCat(xsd)(doc)=
<#base:vitalsigns.VSCat>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< 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.; (xsd)coding:bodyheight.VSCat.coding>+
< 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.; (xsd)text:string>?🔗 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.bodyheight.VSCat.coding(xsd)(doc)=
<#base:vitalsigns.VSCat.coding>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< 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 be an absolute reference to some definition that establishes the system clearly and unambiguously. http://terminology.hl7.org/CodeSystem/observation-category; (xsd)system:uri>
< 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.; (xsd)version:string>?
< 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). vital-signs; (xsd)code>
< A representation of the meaning of the code in the system, following the rules of the system.; (xsd)display:string>?
< 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.; (xsd)userSelected:boolean>?🔗 Record details about an anatomical structure. This resource may be used when a coded concept does not provide the necessary detail needed for the use case.BodyStructure(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< Identifier for this instance of the anatomical structure.; (xsd)identifier:Identifier>*
< Whether this body site is in active use. This element is labeled as a modifier because it may be used to mark that the resource was created in error.; (xsd)active:boolean>?
< The kind of structure being represented by the body structure at `BodyStructure.location`. This can define both normal and abnormal morphologies. The minimum cardinality of 0 supports the use case of specifying a location without defining a morphology. Binding: bodystructure-code (example, Codes describing anatomic morphology.); (xsd)morphology:CodeableConcept>?
[]< The anatomical location(s) or region(s) of the specimen, lesion, or body structure.; (xsd)includedStructure:BodyStructure.includedStructure>+
[]< The anatomical location(s) or region(s) not occupied or represented by the specimen, lesion, or body structure.; (xsd)excludedStructure:BodyStructure.includedStructure>*
< A summary, characterization or explanation of the body structure. This description could include any visual markings used to orientate the viewer e.g. external reference points, special sutures, ink markings.; (xsd)description:markdown>?
[]< Image or images used to identify a location.; (xsd)image:Attachment>*
< The person to which the body site belongs.; (xsd)patient:Patient*>🔗 The anatomical location(s) or region(s) of the specimen, lesion, or body structure.BodyStructure.includedStructure(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Code that represents the included structure. Binding: body-site (example, SNOMED CT Body site concepts); (xsd)structure:CodeableConcept>
< Code that represents the included structure laterality. Binding: bodystructure-relative-location (example, Concepts modifying the anatomic location.); (xsd)laterality:CodeableConcept>?
[]< Body locations in relation to a specific body landmark (tatoo, scar, other body structure).; (xsd)bodyLandmarkOrientation:BodyStructure.includedStructure.bodyLandmarkOrientation>*
[]< XY or XYZ-coordinate orientation for structure.; (xsd)spatialReference:ImagingSelection*>*
[]< Code that represents the included structure qualifier. Binding: bodystructure-relative-location (example, Concepts modifying the anatomic location.); (xsd)qualifier:CodeableConcept>*🔗 Body locations in relation to a specific body landmark (tatoo, scar, other body structure).BodyStructure.includedStructure.bodyLandmarkOrientation(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< A description of a landmark on the body used as a reference to locate something else. Binding: body-site (example, Select SNOMED code system values. Values used in a podiatry setting to decsribe landmarks on the body.); (xsd)landmarkDescription:CodeableConcept>*
[]< An description of the direction away from a landmark something is located based on a radial clock dial. Binding: bodystructure-bodylandmarkorientation-clockface-position (example, Select SNOMED CT codes. A set of codes that describe a things orientation based on a hourly positions of a clock face.); (xsd)clockFacePosition:CodeableConcept>*
[]< The distance in centimeters a certain observation is made from a body landmark.; (xsd)distanceFromLandmark:BodyStructure.includedStructure.bodyLandmarkOrientation.distanceFromLandmark>*
[]< The surface area a body location is in relation to a landmark. Binding: bodystructure-relative-location (preferred, Select SNOMED code system values. The surface area a body location is in relation to a landmark.); (xsd)surfaceOrientation:CodeableConcept>*🔗 The distance in centimeters a certain observation is made from a body landmark.BodyStructure.includedStructure.bodyLandmarkOrientation.distanceFromLandmark(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< An instrument, tool, analyzer, etc. used in the measurement. Binding: device-type (example, Codes to identify medical devices.); (xsd)device:Device*>*
[]< The measured distance (e.g., in cm) from a body landmark.; (xsd)value:Quantity>*🔗 This profile defines how to represent Body Temperature observations in FHIR using a standard LOINC code and UCUM units of measure. Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as laboratory reports, etc.bodytemp(xsd)(doc)=
<#base:vitalsigns>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< A unique identifier assigned to this observation.; (xsd)identifier:Identifier>*
< The reference to a FHIR ObservationDefinition resource that provides the definition that is adhered to in whole or in part by this Observation instance. ObservationDefinition can be referenced by its canonical url using instantiatesCanonical, or by a name or an identifier using the appropriate sub-elements of instantiatesReference.; (xsd)instantiates:ObservationDefinition*>?
[]< A plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed.; (xsd)basedOn:(<CarePlan>
|<DeviceRequest>
|<ImmunizationRecommendation>
|<MedicationRequest>
|<NutritionOrder>
|<ServiceRequest>)>*
[]< Identifies the observation(s) that triggered the performance of this observation.; (xsd)triggeredBy:bodytemp.triggeredBy>*
[]< A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure. To link an Observation to an Encounter use `encounter`. See the [Notes](observation.html#obsgrouping) below for guidance on referencing another Observation.; (xsd)partOf:(<GenomicStudy>
|<ImagingStudy>
|<Immunization>
|<MedicationAdministration>
|<MedicationDispense>
|<MedicationStatement>
|<Procedure>)>*
< The status of the result value. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. Binding: observation-status (required, ); (xsd)status:code>
[]< A code that classifies the general type of observation being made. In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set. Binding: observation-category (preferred, Codes for high level observation categories.); (xsd)category:CodeableConcept>+
< Body Temperature. additional codes that translate or map to this code are allowed. For example a more granular LOINC code or code that is used locally in a system. Binding: observation-vitalsignresult (extensible, This identifies the vital sign result type. Original source C-CDA R1.1 , HITSP Vital Sign Result Type.); (xsd)code:bodytemp.code>
< The patient, or group of patients, location, device, organization, procedure or practitioner this observation is about and into whose or what record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the `focus` element or the `code` itself specifies the actual focus of the observation. One would expect this element to be a cardinality of 1..1. The only circumstance in which the subject can be missing is when the observation is made by a device that does not know the patient. In this case, the observation SHALL be matched to a patient through some context/channel matching technique, and at this point, the observation should be updated. The subject of an Observation may in some cases be a procedure. This supports the regulatory inspection use case where observations are captured during inspections of a procedure that is being performed (independent of any particular patient or whether patient related at all).; (xsd)subject:Patient*>
[]< The actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also be an existing condition, an intervention, the subject's diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child's tracheostomy tube. In this example, the child is the patient of record and the mother is the focus. Typically, an observation is made about the subject - a patient, or group of patients, location, or device - and the distinction between the subject and what is directly measured for an observation is specified in the observation code itself ( e.g., "Blood Glucose") and does not need to be represented separately using this element. Use `specimen` if a reference to a specimen is required. If a code is required instead of a resource use either `bodysite` for bodysites or the standard extension [http://hl7.org/fhir/StructureDefinition/observation-focusCode](http://hl7.org/fhir/extensions/StructureDefinition-observation-focusCode.html).; (xsd)focus:Resource*>*
< The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made. This will typically be the encounter the event occurred within, but some events may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission laboratory tests).; (xsd)encounter:Encounter*>?
< Often just a dateTime for Vital Signs. At least a date should be present unless this observation is a historical report. For recording imprecise or "fuzzy" times (For example, a blood glucose measurement taken "after breakfast") use the [Timing](datatypes.html#timing) datatype which allow the measurement to be tied to regular life events.; (xsd)effective:(<dateTime>
|<Period>)>
< The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified. For Observations that don't require review and verification, it may be the same as the [`lastUpdated` ](resource-definitions.html#Meta.lastUpdated) time of the resource itself. For Observations that do require review and verification for certain updates, it might not be the same as the `lastUpdated` time of the resource itself due to a non-clinically significant update that doesn't require the new version to be reviewed and verified again.; (xsd)issued:instant>?
[]< Who was responsible for asserting the observed value as "true".; (xsd)performer:(<CareTeam>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>*
(<valueAttachment:Attachment>
|<valueBoolean:boolean>
|<valueCodeableConcept:CodeableConcept>
|<valueDateTime:dateTime>
|<valueInteger:integer>
|<valueMolecularSequence:MolecularSequence>
|<valuePeriod:Period>
|<valueQuantity:Quantity>
|<valueRange:Range>
|<valueRatio:Ratio>
|<valueSampledData:SampledData>
|<valueString:string>
|<valueTime:time>)?
< Provides a reason why the expected value in the element Observation.value[x] is missing. Null or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be "detected", "not detected", "inconclusive", or "specimen unsatisfactory".
The alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code "error" could be used when the measurement was not completed. Note that an observation may only be reported if there are values to report. For example differential cell counts values may be reported only when > 0. Because of these options, use-case agreements are required to interpret general observations for null or exceptional values. Binding: data-absent-reason (extensible, Codes specifying why the result (`Observation.value[x]`) is missing.); (xsd)dataAbsentReason:CodeableConcept>?
[]< A categorical assessment of an observation value. For example, high, low, normal. Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Binding: observation-interpretation (extensible, Codes identifying interpretations of observations.); (xsd)interpretation:CodeableConcept>*
[]< Comments about the observation or the results. May include general statements about the observation, or statements about significant, unexpected or unreliable results values, or information about its source when relevant to its interpretation.; (xsd)note:Annotation>*
< Indicates the site on the subject's body where the observation was made (i.e. the target site). Only used if not implicit in code found in Observation.code. In many systems, this may be represented as a related observation instead of an inline component. Binding: body-site (example, SNOMED CT Body site concepts); (xsd)bodySite:CodeableConcept>?
< Indicates the body structure on the subject's body where the observation was made (i.e. the target site). Only used if not implicit in code found in Observation.code or bodySite is used. In many systems, this may be represented as a related observation instead of an inline component.; (xsd)bodyStructure:BodyStructure*>?
< Indicates the mechanism used to perform the observation. Only used if not implicit in code for Observation.code. Binding: observation-methods (example, Methods for simple observations.); (xsd)method:CodeableConcept>?
< The specimen that was used when this observation was made. Should only be used if not implicit in code found in `Observation.code`. Observations are not made on specimens themselves; they are made on a subject, but in many cases by the means of a specimen. Note that although specimens are often involved, they are not always tracked and reported explicitly. Also note that observation resources may be used in contexts that track the specimen explicitly (e.g. Diagnostic Report).; (xsd)specimen:(<Group>
|<Specimen>)>?
< A reference to the device that generates the measurements or the device settings for the device. Note that this is not meant to represent a device involved in the transmission of the result, e.g., a gateway. Such devices may be documented using the Provenance resource where relevant.; (xsd)device:(<Device>
|<DeviceMetric>)>?
[]< Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an "OR". In other words, to represent two distinct target populations, two `referenceRange` elements would be used. Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.; (xsd)referenceRange:bodytemp.referenceRange>*
[]< Used when reporting vital signs panel components. When using this element, an observation will typically have either a value or a set of related resources, although both may be present in some cases. For a discussion on the ways Observations can assembled in groups together, see [Notes](observation.html#obsgrouping) below. Note that a system may calculate results from [QuestionnaireResponse](questionnaireresponse.html) into a final score and represent the score as an Observation.; (xsd)hasMember:(<MolecularSequence>
|<QuestionnaireResponse>
|<vitalsigns>)>*
[]< The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image. All the reference choices that are listed in this element can represent clinical observations and other measurements that may be the source for a derived value. The most common reference will be another Observation. For a discussion on the ways Observations can assembled in groups together, see [Notes](observation.html#obsgrouping) below.; (xsd)derivedFrom:(<DocumentReference>
|<ImagingStudy>
|<MolecularSequence>
|<QuestionnaireResponse>
|<vitalsigns>)>*
[]< Used when reporting systolic and diastolic blood pressure. For a discussion on the ways Observations can be assembled in groups together see [Notes](observation.html#notes) below.; (xsd)component:bodytemp.component>*
< A code that classifies the general type of observation being made. In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set. Binding: observation-category (preferred, Codes for high level observation categories.); (xsd)VSCat:bodytemp.VSCat>
< Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept. - An observation may have:
1. a single value here
1. both a value and a set of related or component values
1. only a set of related or component values.
- If a value is present, the datatype for this element should be determined by the `code`.
- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.
- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.
- The usage of valueReference is restricted to the MolecularSequence resource when used as a definitional resource, not as a patient-specific finding. .
- For additional guidance, see the [Notes section](observation.html#notes) below.; (xsd)valueQuantity:bodytemp.valueQuantity>?🔗 Body Temperature. additional codes that translate or map to this code are allowed. For example a more granular LOINC code or code that is used locally in a system. Binding: observation-vitalsignresult (extensible, This identifies the vital sign result type. Original source C-CDA R1.1 , HITSP Vital Sign Result Type.)bodytemp.code(xsd)(doc)=
<#base:CodeableConcept>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< 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.; (xsd)coding:Coding>*
< 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.; (xsd)text:string>?
< 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.; (xsd)BodyTempCode:bodytemp.code.BodyTempCode>🔗 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.bodytemp.code.BodyTempCode(xsd)(doc)=
<#base:Coding>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< 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 be an absolute reference to some definition that establishes the system clearly and unambiguously. http://loinc.org; (xsd)system:uri>
< 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.; (xsd)version:string>?
< 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). 8310-5; (xsd)code>
< A representation of the meaning of the code in the system, following the rules of the system.; (xsd)display:string>?
< 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.; (xsd)userSelected:boolean>?🔗 Used when reporting systolic and diastolic blood pressure. For a discussion on the ways Observations can be assembled in groups together see [Notes](observation.html#notes) below.bodytemp.component(xsd)(doc)=
<#base:Observation.component>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Describes what was observed. Sometimes this is called the observation "code". *All* code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. Binding: observation-vitalsignresult (extensible, This identifies the vital sign result type. Original source C-CDA R1.1 , HITSP Vital Sign Result Type.); (xsd)code:CodeableConcept>
(<valueAttachment:Attachment>
|<valueBoolean:boolean>
|<valueCodeableConcept:CodeableConcept>
|<valueDateTime:dateTime>
|<valueInteger:integer>
|<valueMolecularSequence:MolecularSequence>
|<valuePeriod:Period>
|<valueQuantity:Quantity>
|<valueRange:Range>
|<valueRatio:Ratio>
|<valueSampledData:SampledData>
|<valueString:string>
|<valueTime:time>)?
< Provides a reason why the expected value in the element Observation.component.value[x] is missing. "Null" or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be "detected", "not detected", "inconclusive", or "test not done".
The alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code "error" could be used when the measurement was not completed. Because of these options, use-case agreements are required to interpret general observations for exceptional values. Binding: data-absent-reason (extensible, Codes specifying why the result (`Observation.value[x]`) is missing.); (xsd)dataAbsentReason:CodeableConcept>?
[]< A categorical assessment of an observation value. For example, high, low, normal. Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Binding: observation-interpretation (extensible, Codes identifying interpretations of observations.); (xsd)interpretation:CodeableConcept>*
[]< Guidance on how to interpret the value by comparison to a normal or recommended range. Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.; (xsd)referenceRange:Observation.referenceRange>*
< Vital Sign Value recorded with UCUM. Used when observation has a set of component observations:
- An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was derived).
- If a value is present, the datatype for this element should be determined by the `code`.
- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.
- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.
- If a value is present, the datatype for this element should be determined by the `code`.
- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.
- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.
- The usage of valueReference is restricted to the MolecularSequence resource when used as a definitional resource, not as a patient-specific finding. .
- For additional guidance, see the [Notes section](observation.html#notes) below. Binding: ucum-vitals-common (required, Commonly encountered UCUM units for recording Vital Signs.); (xsd)valueQuantity:Quantity>?🔗 Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an "OR". In other words, to represent two distinct target populations, two `referenceRange` elements would be used. Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.bodytemp.referenceRange(xsd)(doc)=
<#base:Observation.referenceRange>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The value of the low bound of the reference range. The low bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the low bound is omitted, it is assumed to be meaningless (e.g. reference range is <=2.3).; (xsd)low:SimpleQuantity>?
< The value of the high bound of the reference range. The high bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the high bound is omitted, it is assumed to be meaningless (e.g. reference range is >= 2.3).; (xsd)high:SimpleQuantity>?
< The value of the normal value of the reference range. Binding: observation-referencerange-normalvalue (extensible, Codes identifying the normal value of the observation.); (xsd)normalValue:CodeableConcept>?
< Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range. This SHOULD be populated if there is more than one range. If this element is not present then the normal range is assumed. Binding: referencerange-meaning (preferred, Code for the meaning of a reference range.); (xsd)type:CodeableConcept>?
[]< Codes to indicate the target population this reference range applies to. For example, a reference range may be based on the normal population or a particular sex or race. Multiple `appliesTo` are interpreted as an "AND" of the target populations. For example, to represent a target population of African American females, both a code of female and a code for African American would be used. This SHOULD be populated if there is more than one range. If this element is not present then the normal population is assumed. Binding: referencerange-appliesto (example, Codes identifying the population the reference range applies to.); (xsd)appliesTo:CodeableConcept>*
< The age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so.; (xsd)age:Range>?
< Text based reference range in an observation which may be used when a quantitative range is not appropriate for an observation. An example would be a reference value of "Negative" or a list or table of "normals".; (xsd)text:markdown>?🔗 Identifies the observation(s) that triggered the performance of this observation.bodytemp.triggeredBy(xsd)(doc)=
<#base:Observation.triggeredBy>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Reference to the triggering observation.; (xsd)observation:Observation*>
< The type of trigger.
Reflex | Repeat | Re-run. Binding: observation-triggeredbytype (required, The type of TriggeredBy Observation.); (xsd)type:code>
< Provides the reason why this observation was performed as a result of the observation(s) referenced.; (xsd)reason:string>?🔗 Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept. - An observation may have:
1. a single value here
1. both a value and a set of related or component values
1. only a set of related or component values.
- If a value is present, the datatype for this element should be determined by the `code`.
- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.
- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.
- The usage of valueReference is restricted to the MolecularSequence resource when used as a definitional resource, not as a patient-specific finding. .
- For additional guidance, see the [Notes section](observation.html#notes) below.bodytemp.valueQuantity(xsd)(doc)=
<#base:Quantity>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< 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).; (xsd)value:decimal>
< 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. Binding: quantity-comparator (required, How the Quantity should be understood and represented.); (xsd)comparator:code>?
< A human-readable form of the unit.; (xsd)unit:string>
< The identification of the system that provides the coded form of the unit. http://unitsofmeasure.org; (xsd)system:uri>
< Coded responses from the common UCUM units for vital signs value set. 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. Binding: ucum-bodytemp (required, Cel | [degF]); (xsd)code>🔗 A code that classifies the general type of observation being made. In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set. Binding: observation-category (preferred, Codes for high level observation categories.)bodytemp.VSCat(xsd)(doc)=
<#base:vitalsigns.VSCat>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< 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.; (xsd)coding:bodytemp.VSCat.coding>+
< 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.; (xsd)text:string>?🔗 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.bodytemp.VSCat.coding(xsd)(doc)=
<#base:vitalsigns.VSCat.coding>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< 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 be an absolute reference to some definition that establishes the system clearly and unambiguously. http://terminology.hl7.org/CodeSystem/observation-category; (xsd)system:uri>
< 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.; (xsd)version:string>?
< 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). vital-signs; (xsd)code>
< A representation of the meaning of the code in the system, following the rules of the system.; (xsd)display:string>?
< 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.; (xsd)userSelected:boolean>?🔗 This profile defines how to represent body weight observations in FHIR using a standard LOINC code and UCUM units of measure. Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as laboratory reports, etc.bodyweight(xsd)(doc)=
<#base:vitalsigns>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< A unique identifier assigned to this observation.; (xsd)identifier:Identifier>*
< The reference to a FHIR ObservationDefinition resource that provides the definition that is adhered to in whole or in part by this Observation instance. ObservationDefinition can be referenced by its canonical url using instantiatesCanonical, or by a name or an identifier using the appropriate sub-elements of instantiatesReference.; (xsd)instantiates:ObservationDefinition*>?
[]< A plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed.; (xsd)basedOn:(<CarePlan>
|<DeviceRequest>
|<ImmunizationRecommendation>
|<MedicationRequest>
|<NutritionOrder>
|<ServiceRequest>)>*
[]< Identifies the observation(s) that triggered the performance of this observation.; (xsd)triggeredBy:bodyweight.triggeredBy>*
[]< A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure. To link an Observation to an Encounter use `encounter`. See the [Notes](observation.html#obsgrouping) below for guidance on referencing another Observation.; (xsd)partOf:(<GenomicStudy>
|<ImagingStudy>
|<Immunization>
|<MedicationAdministration>
|<MedicationDispense>
|<MedicationStatement>
|<Procedure>)>*
< The status of the result value. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. Binding: observation-status (required, ); (xsd)status:code>
[]< A code that classifies the general type of observation being made. In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set. Binding: observation-category (preferred, Codes for high level observation categories.); (xsd)category:CodeableConcept>+
< Body Weight. additional codes that translate or map to this code are allowed. For example a more granular LOINC code or code that is used locally in a system. Binding: observation-vitalsignresult (extensible, This identifies the vital sign result type. Original source C-CDA R1.1 , HITSP Vital Sign Result Type.); (xsd)code:bodyweight.code>
< The patient, or group of patients, location, device, organization, procedure or practitioner this observation is about and into whose or what record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the `focus` element or the `code` itself specifies the actual focus of the observation. One would expect this element to be a cardinality of 1..1. The only circumstance in which the subject can be missing is when the observation is made by a device that does not know the patient. In this case, the observation SHALL be matched to a patient through some context/channel matching technique, and at this point, the observation should be updated. The subject of an Observation may in some cases be a procedure. This supports the regulatory inspection use case where observations are captured during inspections of a procedure that is being performed (independent of any particular patient or whether patient related at all).; (xsd)subject:Patient*>
[]< The actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also be an existing condition, an intervention, the subject's diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child's tracheostomy tube. In this example, the child is the patient of record and the mother is the focus. Typically, an observation is made about the subject - a patient, or group of patients, location, or device - and the distinction between the subject and what is directly measured for an observation is specified in the observation code itself ( e.g., "Blood Glucose") and does not need to be represented separately using this element. Use `specimen` if a reference to a specimen is required. If a code is required instead of a resource use either `bodysite` for bodysites or the standard extension [http://hl7.org/fhir/StructureDefinition/observation-focusCode](http://hl7.org/fhir/extensions/StructureDefinition-observation-focusCode.html).; (xsd)focus:Resource*>*
< The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made. This will typically be the encounter the event occurred within, but some events may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission laboratory tests).; (xsd)encounter:Encounter*>?
< Often just a dateTime for Vital Signs. At least a date should be present unless this observation is a historical report. For recording imprecise or "fuzzy" times (For example, a blood glucose measurement taken "after breakfast") use the [Timing](datatypes.html#timing) datatype which allow the measurement to be tied to regular life events.; (xsd)effective:(<dateTime>
|<Period>)>
< The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified. For Observations that don't require review and verification, it may be the same as the [`lastUpdated` ](resource-definitions.html#Meta.lastUpdated) time of the resource itself. For Observations that do require review and verification for certain updates, it might not be the same as the `lastUpdated` time of the resource itself due to a non-clinically significant update that doesn't require the new version to be reviewed and verified again.; (xsd)issued:instant>?
[]< Who was responsible for asserting the observed value as "true".; (xsd)performer:(<CareTeam>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>*
(<valueAttachment:Attachment>
|<valueBoolean:boolean>
|<valueCodeableConcept:CodeableConcept>
|<valueDateTime:dateTime>
|<valueInteger:integer>
|<valueMolecularSequence:MolecularSequence>
|<valuePeriod:Period>
|<valueQuantity:Quantity>
|<valueRange:Range>
|<valueRatio:Ratio>
|<valueSampledData:SampledData>
|<valueString:string>
|<valueTime:time>)?
< Provides a reason why the expected value in the element Observation.value[x] is missing. Null or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be "detected", "not detected", "inconclusive", or "specimen unsatisfactory".
The alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code "error" could be used when the measurement was not completed. Note that an observation may only be reported if there are values to report. For example differential cell counts values may be reported only when > 0. Because of these options, use-case agreements are required to interpret general observations for null or exceptional values. Binding: data-absent-reason (extensible, Codes specifying why the result (`Observation.value[x]`) is missing.); (xsd)dataAbsentReason:CodeableConcept>?
[]< A categorical assessment of an observation value. For example, high, low, normal. Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Binding: observation-interpretation (extensible, Codes identifying interpretations of observations.); (xsd)interpretation:CodeableConcept>*
[]< Comments about the observation or the results. May include general statements about the observation, or statements about significant, unexpected or unreliable results values, or information about its source when relevant to its interpretation.; (xsd)note:Annotation>*
< Indicates the site on the subject's body where the observation was made (i.e. the target site). Only used if not implicit in code found in Observation.code. In many systems, this may be represented as a related observation instead of an inline component. Binding: body-site (example, SNOMED CT Body site concepts); (xsd)bodySite:CodeableConcept>?
< Indicates the body structure on the subject's body where the observation was made (i.e. the target site). Only used if not implicit in code found in Observation.code or bodySite is used. In many systems, this may be represented as a related observation instead of an inline component.; (xsd)bodyStructure:BodyStructure*>?
< Indicates the mechanism used to perform the observation. Only used if not implicit in code for Observation.code. Binding: observation-methods (example, Methods for simple observations.); (xsd)method:CodeableConcept>?
< The specimen that was used when this observation was made. Should only be used if not implicit in code found in `Observation.code`. Observations are not made on specimens themselves; they are made on a subject, but in many cases by the means of a specimen. Note that although specimens are often involved, they are not always tracked and reported explicitly. Also note that observation resources may be used in contexts that track the specimen explicitly (e.g. Diagnostic Report).; (xsd)specimen:(<Group>
|<Specimen>)>?
< A reference to the device that generates the measurements or the device settings for the device. Note that this is not meant to represent a device involved in the transmission of the result, e.g., a gateway. Such devices may be documented using the Provenance resource where relevant.; (xsd)device:(<Device>
|<DeviceMetric>)>?
[]< Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an "OR". In other words, to represent two distinct target populations, two `referenceRange` elements would be used. Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.; (xsd)referenceRange:bodyweight.referenceRange>*
[]< Used when reporting vital signs panel components. When using this element, an observation will typically have either a value or a set of related resources, although both may be present in some cases. For a discussion on the ways Observations can assembled in groups together, see [Notes](observation.html#obsgrouping) below. Note that a system may calculate results from [QuestionnaireResponse](questionnaireresponse.html) into a final score and represent the score as an Observation.; (xsd)hasMember:(<MolecularSequence>
|<QuestionnaireResponse>
|<vitalsigns>)>*
[]< The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image. All the reference choices that are listed in this element can represent clinical observations and other measurements that may be the source for a derived value. The most common reference will be another Observation. For a discussion on the ways Observations can assembled in groups together, see [Notes](observation.html#obsgrouping) below.; (xsd)derivedFrom:(<DocumentReference>
|<ImagingStudy>
|<MolecularSequence>
|<QuestionnaireResponse>
|<vitalsigns>)>*
[]< Used when reporting systolic and diastolic blood pressure. For a discussion on the ways Observations can be assembled in groups together see [Notes](observation.html#notes) below.; (xsd)component:bodyweight.component>*
< A code that classifies the general type of observation being made. In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set. Binding: observation-category (preferred, Codes for high level observation categories.); (xsd)VSCat:bodyweight.VSCat>
< Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept. - An observation may have:
1. a single value here
1. both a value and a set of related or component values
1. only a set of related or component values.
- If a value is present, the datatype for this element should be determined by the `code`.
- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.
- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.
- The usage of valueReference is restricted to the MolecularSequence resource when used as a definitional resource, not as a patient-specific finding. .
- For additional guidance, see the [Notes section](observation.html#notes) below.; (xsd)valueQuantity:bodyweight.valueQuantity>?🔗 Body Weight. additional codes that translate or map to this code are allowed. For example a more granular LOINC code or code that is used locally in a system. Binding: observation-vitalsignresult (extensible, This identifies the vital sign result type. Original source C-CDA R1.1 , HITSP Vital Sign Result Type.)bodyweight.code(xsd)(doc)=
<#base:CodeableConcept>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< 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.; (xsd)coding:Coding>*
< 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.; (xsd)text:string>?
< 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.; (xsd)BodyWeightCode:bodyweight.code.BodyWeightCode>🔗 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.bodyweight.code.BodyWeightCode(xsd)(doc)=
<#base:Coding>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< 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 be an absolute reference to some definition that establishes the system clearly and unambiguously. http://loinc.org; (xsd)system:uri>
< 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.; (xsd)version:string>?
< 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). 29463-7; (xsd)code>
< A representation of the meaning of the code in the system, following the rules of the system.; (xsd)display:string>?
< 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.; (xsd)userSelected:boolean>?🔗 Used when reporting systolic and diastolic blood pressure. For a discussion on the ways Observations can be assembled in groups together see [Notes](observation.html#notes) below.bodyweight.component(xsd)(doc)=
<#base:Observation.component>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Describes what was observed. Sometimes this is called the observation "code". *All* code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. Binding: observation-vitalsignresult (extensible, This identifies the vital sign result type. Original source C-CDA R1.1 , HITSP Vital Sign Result Type.); (xsd)code:CodeableConcept>
(<valueAttachment:Attachment>
|<valueBoolean:boolean>
|<valueCodeableConcept:CodeableConcept>
|<valueDateTime:dateTime>
|<valueInteger:integer>
|<valueMolecularSequence:MolecularSequence>
|<valuePeriod:Period>
|<valueQuantity:Quantity>
|<valueRange:Range>
|<valueRatio:Ratio>
|<valueSampledData:SampledData>
|<valueString:string>
|<valueTime:time>)?
< Provides a reason why the expected value in the element Observation.component.value[x] is missing. "Null" or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be "detected", "not detected", "inconclusive", or "test not done".
The alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code "error" could be used when the measurement was not completed. Because of these options, use-case agreements are required to interpret general observations for exceptional values. Binding: data-absent-reason (extensible, Codes specifying why the result (`Observation.value[x]`) is missing.); (xsd)dataAbsentReason:CodeableConcept>?
[]< A categorical assessment of an observation value. For example, high, low, normal. Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Binding: observation-interpretation (extensible, Codes identifying interpretations of observations.); (xsd)interpretation:CodeableConcept>*
[]< Guidance on how to interpret the value by comparison to a normal or recommended range. Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.; (xsd)referenceRange:Observation.referenceRange>*
< Vital Sign Value recorded with UCUM. Used when observation has a set of component observations:
- An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was derived).
- If a value is present, the datatype for this element should be determined by the `code`.
- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.
- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.
- If a value is present, the datatype for this element should be determined by the `code`.
- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.
- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.
- The usage of valueReference is restricted to the MolecularSequence resource when used as a definitional resource, not as a patient-specific finding. .
- For additional guidance, see the [Notes section](observation.html#notes) below. Binding: ucum-vitals-common (required, Commonly encountered UCUM units for recording Vital Signs.); (xsd)valueQuantity:Quantity>?🔗 Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an "OR". In other words, to represent two distinct target populations, two `referenceRange` elements would be used. Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.bodyweight.referenceRange(xsd)(doc)=
<#base:Observation.referenceRange>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The value of the low bound of the reference range. The low bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the low bound is omitted, it is assumed to be meaningless (e.g. reference range is <=2.3).; (xsd)low:SimpleQuantity>?
< The value of the high bound of the reference range. The high bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the high bound is omitted, it is assumed to be meaningless (e.g. reference range is >= 2.3).; (xsd)high:SimpleQuantity>?
< The value of the normal value of the reference range. Binding: observation-referencerange-normalvalue (extensible, Codes identifying the normal value of the observation.); (xsd)normalValue:CodeableConcept>?
< Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range. This SHOULD be populated if there is more than one range. If this element is not present then the normal range is assumed. Binding: referencerange-meaning (preferred, Code for the meaning of a reference range.); (xsd)type:CodeableConcept>?
[]< Codes to indicate the target population this reference range applies to. For example, a reference range may be based on the normal population or a particular sex or race. Multiple `appliesTo` are interpreted as an "AND" of the target populations. For example, to represent a target population of African American females, both a code of female and a code for African American would be used. This SHOULD be populated if there is more than one range. If this element is not present then the normal population is assumed. Binding: referencerange-appliesto (example, Codes identifying the population the reference range applies to.); (xsd)appliesTo:CodeableConcept>*
< The age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so.; (xsd)age:Range>?
< Text based reference range in an observation which may be used when a quantitative range is not appropriate for an observation. An example would be a reference value of "Negative" or a list or table of "normals".; (xsd)text:markdown>?🔗 Identifies the observation(s) that triggered the performance of this observation.bodyweight.triggeredBy(xsd)(doc)=
<#base:Observation.triggeredBy>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Reference to the triggering observation.; (xsd)observation:Observation*>
< The type of trigger.
Reflex | Repeat | Re-run. Binding: observation-triggeredbytype (required, The type of TriggeredBy Observation.); (xsd)type:code>
< Provides the reason why this observation was performed as a result of the observation(s) referenced.; (xsd)reason:string>?🔗 Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept. - An observation may have:
1. a single value here
1. both a value and a set of related or component values
1. only a set of related or component values.
- If a value is present, the datatype for this element should be determined by the `code`.
- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.
- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.
- The usage of valueReference is restricted to the MolecularSequence resource when used as a definitional resource, not as a patient-specific finding. .
- For additional guidance, see the [Notes section](observation.html#notes) below.bodyweight.valueQuantity(xsd)(doc)=
<#base:Quantity>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< 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).; (xsd)value:decimal>
< 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. Binding: quantity-comparator (required, How the Quantity should be understood and represented.); (xsd)comparator:code>?
< A human-readable form of the unit.; (xsd)unit:string>
< The identification of the system that provides the coded form of the unit. http://unitsofmeasure.org; (xsd)system:uri>
< Coded responses from the common UCUM units for vital signs value set. 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. Binding: ucum-bodyweight (required, g | kg | [lb_av]); (xsd)code>🔗 A code that classifies the general type of observation being made. In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set. Binding: observation-category (preferred, Codes for high level observation categories.)bodyweight.VSCat(xsd)(doc)=
<#base:vitalsigns.VSCat>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< 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.; (xsd)coding:bodyweight.VSCat.coding>+
< 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.; (xsd)text:string>?🔗 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.bodyweight.VSCat.coding(xsd)(doc)=
<#base:vitalsigns.VSCat.coding>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< 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 be an absolute reference to some definition that establishes the system clearly and unambiguously. http://terminology.hl7.org/CodeSystem/observation-category; (xsd)system:uri>
< 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.; (xsd)version:string>?
< 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). vital-signs; (xsd)code>
< A representation of the meaning of the code in the system, following the rules of the system.; (xsd)display:string>?
< 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.; (xsd)userSelected:boolean>?🔗 Value of "true" or "false"boolean(xsd)(doc)=
<#base:PrimitiveType>
< unique id for the element within a resource (for internal references); (xsd)id:string>?
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< The actual value; (xsd)value:boolean>?🔗 This profile defines how to represent Blood Pressure observations in FHIR using a standard LOINC code and UCUM units of measure. This is a grouping structure. It has no value in Observation.valueQuantity but contains at least one component (systolic and/or diastolic). Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as laboratory reports, etc.bp(xsd)(doc)=
<#base:vitalsigns>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< A unique identifier assigned to this observation.; (xsd)identifier:Identifier>*
< The reference to a FHIR ObservationDefinition resource that provides the definition that is adhered to in whole or in part by this Observation instance. ObservationDefinition can be referenced by its canonical url using instantiatesCanonical, or by a name or an identifier using the appropriate sub-elements of instantiatesReference.; (xsd)instantiates:ObservationDefinition*>?
[]< A plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed.; (xsd)basedOn:(<CarePlan>
|<DeviceRequest>
|<ImmunizationRecommendation>
|<MedicationRequest>
|<NutritionOrder>
|<ServiceRequest>)>*
[]< Identifies the observation(s) that triggered the performance of this observation.; (xsd)triggeredBy:bp.triggeredBy>*
[]< A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure. To link an Observation to an Encounter use `encounter`. See the [Notes](observation.html#obsgrouping) below for guidance on referencing another Observation.; (xsd)partOf:(<GenomicStudy>
|<ImagingStudy>
|<Immunization>
|<MedicationAdministration>
|<MedicationDispense>
|<MedicationStatement>
|<Procedure>)>*
< The status of the result value. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. Binding: observation-status (required, ); (xsd)status:code>
[]< A code that classifies the general type of observation being made. In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set. Binding: observation-category (preferred, Codes for high level observation categories.); (xsd)category:CodeableConcept>+
< Blood Pressure. additional codes that translate or map to this code are allowed. For example a more granular LOINC code or code that is used locally in a system. Binding: observation-vitalsignresult (extensible, This identifies the vital sign result type. Original source C-CDA R1.1 , HITSP Vital Sign Result Type.); (xsd)code:bp.code>
< The patient, or group of patients, location, device, organization, procedure or practitioner this observation is about and into whose or what record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the `focus` element or the `code` itself specifies the actual focus of the observation. One would expect this element to be a cardinality of 1..1. The only circumstance in which the subject can be missing is when the observation is made by a device that does not know the patient. In this case, the observation SHALL be matched to a patient through some context/channel matching technique, and at this point, the observation should be updated. The subject of an Observation may in some cases be a procedure. This supports the regulatory inspection use case where observations are captured during inspections of a procedure that is being performed (independent of any particular patient or whether patient related at all).; (xsd)subject:Patient*>
[]< The actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also be an existing condition, an intervention, the subject's diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child's tracheostomy tube. In this example, the child is the patient of record and the mother is the focus. Typically, an observation is made about the subject - a patient, or group of patients, location, or device - and the distinction between the subject and what is directly measured for an observation is specified in the observation code itself ( e.g., "Blood Glucose") and does not need to be represented separately using this element. Use `specimen` if a reference to a specimen is required. If a code is required instead of a resource use either `bodysite` for bodysites or the standard extension [http://hl7.org/fhir/StructureDefinition/observation-focusCode](http://hl7.org/fhir/extensions/StructureDefinition-observation-focusCode.html).; (xsd)focus:Resource*>*
< The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made. This will typically be the encounter the event occurred within, but some events may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission laboratory tests).; (xsd)encounter:Encounter*>?
< Often just a dateTime for Vital Signs. At least a date should be present unless this observation is a historical report. For recording imprecise or "fuzzy" times (For example, a blood glucose measurement taken "after breakfast") use the [Timing](datatypes.html#timing) datatype which allow the measurement to be tied to regular life events.; (xsd)effective:(<dateTime>
|<Period>)>
< The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified. For Observations that don't require review and verification, it may be the same as the [`lastUpdated` ](resource-definitions.html#Meta.lastUpdated) time of the resource itself. For Observations that do require review and verification for certain updates, it might not be the same as the `lastUpdated` time of the resource itself due to a non-clinically significant update that doesn't require the new version to be reviewed and verified again.; (xsd)issued:instant>?
[]< Who was responsible for asserting the observed value as "true".; (xsd)performer:(<CareTeam>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>*
(<valueAttachment:Attachment>
|<valueBoolean:boolean>
|<valueCodeableConcept:CodeableConcept>
|<valueDateTime:dateTime>
|<valueInteger:integer>
|<valueMolecularSequence:MolecularSequence>
|<valuePeriod:Period>
|<valueQuantity:Quantity>
|<valueRange:Range>
|<valueRatio:Ratio>
|<valueSampledData:SampledData>
|<valueString:string>
|<valueTime:time>)?
< Provides a reason why the expected value in the element Observation.value[x] is missing. Null or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be "detected", "not detected", "inconclusive", or "specimen unsatisfactory".
The alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code "error" could be used when the measurement was not completed. Note that an observation may only be reported if there are values to report. For example differential cell counts values may be reported only when > 0. Because of these options, use-case agreements are required to interpret general observations for null or exceptional values. Binding: data-absent-reason (extensible, Codes specifying why the result (`Observation.value[x]`) is missing.); (xsd)dataAbsentReason:CodeableConcept>?
[]< A categorical assessment of an observation value. For example, high, low, normal. Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Binding: observation-interpretation (extensible, Codes identifying interpretations of observations.); (xsd)interpretation:CodeableConcept>*
[]< Comments about the observation or the results. May include general statements about the observation, or statements about significant, unexpected or unreliable results values, or information about its source when relevant to its interpretation.; (xsd)note:Annotation>*
< Indicates the site on the subject's body where the observation was made (i.e. the target site). Only used if not implicit in code found in Observation.code. In many systems, this may be represented as a related observation instead of an inline component. Binding: body-site (example, SNOMED CT Body site concepts); (xsd)bodySite:CodeableConcept>?
< Indicates the body structure on the subject's body where the observation was made (i.e. the target site). Only used if not implicit in code found in Observation.code or bodySite is used. In many systems, this may be represented as a related observation instead of an inline component.; (xsd)bodyStructure:BodyStructure*>?
< Indicates the mechanism used to perform the observation. Only used if not implicit in code for Observation.code. Binding: observation-methods (example, Methods for simple observations.); (xsd)method:CodeableConcept>?
< The specimen that was used when this observation was made. Should only be used if not implicit in code found in `Observation.code`. Observations are not made on specimens themselves; they are made on a subject, but in many cases by the means of a specimen. Note that although specimens are often involved, they are not always tracked and reported explicitly. Also note that observation resources may be used in contexts that track the specimen explicitly (e.g. Diagnostic Report).; (xsd)specimen:(<Group>
|<Specimen>)>?
< A reference to the device that generates the measurements or the device settings for the device. Note that this is not meant to represent a device involved in the transmission of the result, e.g., a gateway. Such devices may be documented using the Provenance resource where relevant.; (xsd)device:(<Device>
|<DeviceMetric>)>?
[]< Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an "OR". In other words, to represent two distinct target populations, two `referenceRange` elements would be used. Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.; (xsd)referenceRange:bp.referenceRange>*
[]< Used when reporting vital signs panel components. When using this element, an observation will typically have either a value or a set of related resources, although both may be present in some cases. For a discussion on the ways Observations can assembled in groups together, see [Notes](observation.html#obsgrouping) below. Note that a system may calculate results from [QuestionnaireResponse](questionnaireresponse.html) into a final score and represent the score as an Observation.; (xsd)hasMember:(<MolecularSequence>
|<QuestionnaireResponse>
|<vitalsigns>)>*
[]< The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image. All the reference choices that are listed in this element can represent clinical observations and other measurements that may be the source for a derived value. The most common reference will be another Observation. For a discussion on the ways Observations can assembled in groups together, see [Notes](observation.html#obsgrouping) below.; (xsd)derivedFrom:(<DocumentReference>
|<ImagingStudy>
|<MolecularSequence>
|<QuestionnaireResponse>
|<vitalsigns>)>*
[]< Used when reporting systolic and diastolic blood pressure. For a discussion on the ways Observations can be assembled in groups together see [Notes](observation.html#notes) below.; (xsd)component:bp.component>{2,2147483647}
< A code that classifies the general type of observation being made. In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set. Binding: observation-category (preferred, Codes for high level observation categories.); (xsd)VSCat:bp.VSCat>
< Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept. - An observation may have:
1. a single value here
1. both a value and a set of related or component values
1. only a set of related or component values.
- If a value is present, the datatype for this element should be determined by the `code`.
- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.
- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.
- The usage of valueReference is restricted to the MolecularSequence resource when used as a definitional resource, not as a patient-specific finding. .
- For additional guidance, see the [Notes section](observation.html#notes) below.; (xsd)valueQuantity:Quantity>{0,0}
< Used when reporting systolic and diastolic blood pressure. For a discussion on the ways Observations can be assembled in groups together see [Notes](observation.html#notes) below.; (xsd)SystolicBP:bp.SystolicBP>
< Used when reporting systolic and diastolic blood pressure. For a discussion on the ways Observations can be assembled in groups together see [Notes](observation.html#notes) below.; (xsd)DiastolicBP:bp.DiastolicBP>🔗 Blood Pressure. additional codes that translate or map to this code are allowed. For example a more granular LOINC code or code that is used locally in a system. Binding: observation-vitalsignresult (extensible, This identifies the vital sign result type. Original source C-CDA R1.1 , HITSP Vital Sign Result Type.)bp.code(xsd)(doc)=
<#base:CodeableConcept>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< 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.; (xsd)coding:Coding>*
< 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.; (xsd)text:string>?
< 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.; (xsd)BPCode:bp.code.BPCode>🔗 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.bp.code.BPCode(xsd)(doc)=
<#base:Coding>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< 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 be an absolute reference to some definition that establishes the system clearly and unambiguously. http://loinc.org; (xsd)system:uri>
< 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.; (xsd)version:string>?
< 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). 85354-9; (xsd)code>
< A representation of the meaning of the code in the system, following the rules of the system.; (xsd)display:string>?
< 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.; (xsd)userSelected:boolean>?🔗 Used when reporting systolic and diastolic blood pressure. For a discussion on the ways Observations can be assembled in groups together see [Notes](observation.html#notes) below.bp.component(xsd)(doc)=
<#base:Observation.component>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Describes what was observed. Sometimes this is called the observation "code". *All* code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. Binding: observation-vitalsignresult (extensible, This identifies the vital sign result type. Original source C-CDA R1.1 , HITSP Vital Sign Result Type.); (xsd)code:CodeableConcept>
(<valueAttachment:Attachment>
|<valueBoolean:boolean>
|<valueCodeableConcept:CodeableConcept>
|<valueDateTime:dateTime>
|<valueInteger:integer>
|<valueMolecularSequence:MolecularSequence>
|<valuePeriod:Period>
|<valueQuantity:Quantity>
|<valueRange:Range>
|<valueRatio:Ratio>
|<valueSampledData:SampledData>
|<valueString:string>
|<valueTime:time>)?
< Provides a reason why the expected value in the element Observation.component.value[x] is missing. "Null" or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be "detected", "not detected", "inconclusive", or "test not done".
The alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code "error" could be used when the measurement was not completed. Because of these options, use-case agreements are required to interpret general observations for exceptional values. Binding: data-absent-reason (extensible, Codes specifying why the result (`Observation.value[x]`) is missing.); (xsd)dataAbsentReason:CodeableConcept>?
[]< A categorical assessment of an observation value. For example, high, low, normal. Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Binding: observation-interpretation (extensible, Codes identifying interpretations of observations.); (xsd)interpretation:CodeableConcept>*
[]< Guidance on how to interpret the value by comparison to a normal or recommended range. Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.; (xsd)referenceRange:Observation.referenceRange>*
< Vital Sign Value recorded with UCUM. Used when observation has a set of component observations:
- An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was derived).
- If a value is present, the datatype for this element should be determined by the `code`.
- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.
- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.
- If a value is present, the datatype for this element should be determined by the `code`.
- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.
- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.
- The usage of valueReference is restricted to the MolecularSequence resource when used as a definitional resource, not as a patient-specific finding. .
- For additional guidance, see the [Notes section](observation.html#notes) below. Binding: ucum-vitals-common (required, Commonly encountered UCUM units for recording Vital Signs.); (xsd)valueQuantity:Quantity>?🔗 Used when reporting systolic and diastolic blood pressure. For a discussion on the ways Observations can be assembled in groups together see [Notes](observation.html#notes) below.bp.DiastolicBP(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Describes what was observed. Sometimes this is called the observation "code". additional codes that translate or map to this code are allowed. For example a more granular LOINC code or code that is used locally in a system. Binding: observation-vitalsignresult (extensible, This identifies the vital sign result type. Original source C-CDA R1.1 , HITSP Vital Sign Result Type.); (xsd)code:bp.DiastolicBP.code>
(<valueAttachment:Attachment>
|<valueBoolean:boolean>
|<valueCodeableConcept:CodeableConcept>
|<valueDateTime:dateTime>
|<valueInteger:integer>
|<valueMolecularSequence:MolecularSequence>
|<valuePeriod:Period>
|<valueQuantity:Quantity>
|<valueRange:Range>
|<valueRatio:Ratio>
|<valueSampledData:SampledData>
|<valueString:string>
|<valueTime:time>)?
< Provides a reason why the expected value in the element Observation.component.value[x] is missing. "Null" or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be "detected", "not detected", "inconclusive", or "test not done".
The alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code "error" could be used when the measurement was not completed. Because of these options, use-case agreements are required to interpret general observations for exceptional values. Binding: data-absent-reason (extensible, Codes specifying why the result (`Observation.value[x]`) is missing.); (xsd)dataAbsentReason:CodeableConcept>?
[]< A categorical assessment of an observation value. For example, high, low, normal. Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Binding: observation-interpretation (extensible, Codes identifying interpretations of observations.); (xsd)interpretation:CodeableConcept>*
[]< Guidance on how to interpret the value by comparison to a normal or recommended range. Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.; (xsd)referenceRange:Observation.referenceRange>*
< Vital Sign Value recorded with UCUM. Used when observation has a set of component observations:
- An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was derived).
- If a value is present, the datatype for this element should be determined by the `code`.
- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.
- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.
- If a value is present, the datatype for this element should be determined by the `code`.
- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.
- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.
- The usage of valueReference is restricted to the MolecularSequence resource when used as a definitional resource, not as a patient-specific finding. .
- For additional guidance, see the [Notes section](observation.html#notes) below. Binding: ucum-vitals-common (required, Commonly encountered UCUM units for recording Vital Signs.); (xsd)valueQuantity:bp.DiastolicBP.valueQuantity>?🔗 Describes what was observed. Sometimes this is called the observation "code". additional codes that translate or map to this code are allowed. For example a more granular LOINC code or code that is used locally in a system. Binding: observation-vitalsignresult (extensible, This identifies the vital sign result type. Original source C-CDA R1.1 , HITSP Vital Sign Result Type.)bp.DiastolicBP.code(xsd)(doc)=
<#base:CodeableConcept>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< Diastolic Blood Pressure. 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.; (xsd)coding:Coding>*
< 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.; (xsd)text:string>?
< Diastolic Blood Pressure. 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.; (xsd)DBPCode:bp.DiastolicBP.code.DBPCode>🔗 Diastolic Blood Pressure. 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.bp.DiastolicBP.code.DBPCode(xsd)(doc)=
<#base:Coding>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< 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 be an absolute reference to some definition that establishes the system clearly and unambiguously. http://loinc.org; (xsd)system:uri>
< 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.; (xsd)version:string>?
< 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). 8462-4; (xsd)code>
< A representation of the meaning of the code in the system, following the rules of the system.; (xsd)display:string>?
< 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.; (xsd)userSelected:boolean>?🔗 Vital Sign Value recorded with UCUM. Used when observation has a set of component observations:
- An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was derived).
- If a value is present, the datatype for this element should be determined by the `code`.
- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.
- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.
- If a value is present, the datatype for this element should be determined by the `code`.
- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.
- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.
- The usage of valueReference is restricted to the MolecularSequence resource when used as a definitional resource, not as a patient-specific finding. .
- For additional guidance, see the [Notes section](observation.html#notes) below. Binding: ucum-vitals-common (required, Commonly encountered UCUM units for recording Vital Signs.)bp.DiastolicBP.valueQuantity(xsd)(doc)=
<#base:Quantity>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< 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).; (xsd)value:decimal>
< 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. Binding: quantity-comparator (required, How the Quantity should be understood and represented.); (xsd)comparator:code>?
< A human-readable form of the unit.; (xsd)unit:string>
< The identification of the system that provides the coded form of the unit. http://unitsofmeasure.org; (xsd)system:uri>
< Coded responses from the common UCUM units for vital signs value set. 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. mm[Hg]; (xsd)code>🔗 Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an "OR". In other words, to represent two distinct target populations, two `referenceRange` elements would be used. Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.bp.referenceRange(xsd)(doc)=
<#base:Observation.referenceRange>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The value of the low bound of the reference range. The low bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the low bound is omitted, it is assumed to be meaningless (e.g. reference range is <=2.3).; (xsd)low:SimpleQuantity>?
< The value of the high bound of the reference range. The high bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the high bound is omitted, it is assumed to be meaningless (e.g. reference range is >= 2.3).; (xsd)high:SimpleQuantity>?
< The value of the normal value of the reference range. Binding: observation-referencerange-normalvalue (extensible, Codes identifying the normal value of the observation.); (xsd)normalValue:CodeableConcept>?
< Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range. This SHOULD be populated if there is more than one range. If this element is not present then the normal range is assumed. Binding: referencerange-meaning (preferred, Code for the meaning of a reference range.); (xsd)type:CodeableConcept>?
[]< Codes to indicate the target population this reference range applies to. For example, a reference range may be based on the normal population or a particular sex or race. Multiple `appliesTo` are interpreted as an "AND" of the target populations. For example, to represent a target population of African American females, both a code of female and a code for African American would be used. This SHOULD be populated if there is more than one range. If this element is not present then the normal population is assumed. Binding: referencerange-appliesto (example, Codes identifying the population the reference range applies to.); (xsd)appliesTo:CodeableConcept>*
< The age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so.; (xsd)age:Range>?
< Text based reference range in an observation which may be used when a quantitative range is not appropriate for an observation. An example would be a reference value of "Negative" or a list or table of "normals".; (xsd)text:markdown>?🔗 Used when reporting systolic and diastolic blood pressure. For a discussion on the ways Observations can be assembled in groups together see [Notes](observation.html#notes) below.bp.SystolicBP(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Describes what was observed. Sometimes this is called the observation "code". additional codes that translate or map to this code are allowed. For example a more granular LOINC code or code that is used locally in a system. Binding: observation-vitalsignresult (extensible, This identifies the vital sign result type. Original source C-CDA R1.1 , HITSP Vital Sign Result Type.); (xsd)code:bp.SystolicBP.code>
(<valueAttachment:Attachment>
|<valueBoolean:boolean>
|<valueCodeableConcept:CodeableConcept>
|<valueDateTime:dateTime>
|<valueInteger:integer>
|<valueMolecularSequence:MolecularSequence>
|<valuePeriod:Period>
|<valueQuantity:Quantity>
|<valueRange:Range>
|<valueRatio:Ratio>
|<valueSampledData:SampledData>
|<valueString:string>
|<valueTime:time>)?
< Provides a reason why the expected value in the element Observation.component.value[x] is missing. "Null" or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be "detected", "not detected", "inconclusive", or "test not done".
The alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code "error" could be used when the measurement was not completed. Because of these options, use-case agreements are required to interpret general observations for exceptional values. Binding: data-absent-reason (extensible, Codes specifying why the result (`Observation.value[x]`) is missing.); (xsd)dataAbsentReason:CodeableConcept>?
[]< A categorical assessment of an observation value. For example, high, low, normal. Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Binding: observation-interpretation (extensible, Codes identifying interpretations of observations.); (xsd)interpretation:CodeableConcept>*
[]< Guidance on how to interpret the value by comparison to a normal or recommended range. Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.; (xsd)referenceRange:Observation.referenceRange>*
< Vital Sign Value recorded with UCUM. Used when observation has a set of component observations:
- An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was derived).
- If a value is present, the datatype for this element should be determined by the `code`.
- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.
- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.
- If a value is present, the datatype for this element should be determined by the `code`.
- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.
- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.
- The usage of valueReference is restricted to the MolecularSequence resource when used as a definitional resource, not as a patient-specific finding. .
- For additional guidance, see the [Notes section](observation.html#notes) below. Binding: ucum-vitals-common (required, Commonly encountered UCUM units for recording Vital Signs.); (xsd)valueQuantity:bp.SystolicBP.valueQuantity>?🔗 Describes what was observed. Sometimes this is called the observation "code". additional codes that translate or map to this code are allowed. For example a more granular LOINC code or code that is used locally in a system. Binding: observation-vitalsignresult (extensible, This identifies the vital sign result type. Original source C-CDA R1.1 , HITSP Vital Sign Result Type.)bp.SystolicBP.code(xsd)(doc)=
<#base:CodeableConcept>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< Systolic Blood Pressure. 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.; (xsd)coding:Coding>*
< 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.; (xsd)text:string>?
< Systolic Blood Pressure. 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.; (xsd)SBPCode:bp.SystolicBP.code.SBPCode>🔗 Systolic Blood Pressure. 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.bp.SystolicBP.code.SBPCode(xsd)(doc)=
<#base:Coding>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< 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 be an absolute reference to some definition that establishes the system clearly and unambiguously. http://loinc.org; (xsd)system:uri>
< 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.; (xsd)version:string>?
< 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). 8480-6; (xsd)code>
< A representation of the meaning of the code in the system, following the rules of the system.; (xsd)display:string>?
< 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.; (xsd)userSelected:boolean>?🔗 Vital Sign Value recorded with UCUM. Used when observation has a set of component observations:
- An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was derived).
- If a value is present, the datatype for this element should be determined by the `code`.
- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.
- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.
- If a value is present, the datatype for this element should be determined by the `code`.
- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.
- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.
- The usage of valueReference is restricted to the MolecularSequence resource when used as a definitional resource, not as a patient-specific finding. .
- For additional guidance, see the [Notes section](observation.html#notes) below. Binding: ucum-vitals-common (required, Commonly encountered UCUM units for recording Vital Signs.)bp.SystolicBP.valueQuantity(xsd)(doc)=
<#base:Quantity>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< 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).; (xsd)value:decimal>
< 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. Binding: quantity-comparator (required, How the Quantity should be understood and represented.); (xsd)comparator:code>?
< A human-readable form of the unit.; (xsd)unit:string>
< The identification of the system that provides the coded form of the unit. http://unitsofmeasure.org; (xsd)system:uri>
< Coded responses from the common UCUM units for vital signs value set. 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. mm[Hg]; (xsd)code>🔗 Identifies the observation(s) that triggered the performance of this observation.bp.triggeredBy(xsd)(doc)=
<#base:Observation.triggeredBy>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Reference to the triggering observation.; (xsd)observation:Observation*>
< The type of trigger.
Reflex | Repeat | Re-run. Binding: observation-triggeredbytype (required, The type of TriggeredBy Observation.); (xsd)type:code>
< Provides the reason why this observation was performed as a result of the observation(s) referenced.; (xsd)reason:string>?🔗 A code that classifies the general type of observation being made. In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set. Binding: observation-category (preferred, Codes for high level observation categories.)bp.VSCat(xsd)(doc)=
<#base:vitalsigns.VSCat>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< 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.; (xsd)coding:bp.VSCat.coding>+
< 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.; (xsd)text:string>?🔗 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.bp.VSCat.coding(xsd)(doc)=
<#base:vitalsigns.VSCat.coding>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< 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 be an absolute reference to some definition that establishes the system clearly and unambiguously. http://terminology.hl7.org/CodeSystem/observation-category; (xsd)system:uri>
< 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.; (xsd)version:string>?
< 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). vital-signs; (xsd)code>
< A representation of the meaning of the code in the system, following the rules of the system.; (xsd)display:string>?
< 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.; (xsd)userSelected:boolean>?🔗 A container for a collection of resources.Bundle(xsd)(doc)=
<#base:Resource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< A persistent identifier for the bundle that won't change as a bundle is copied from server to server. Persistent identity generally only matters for batches of type Document, Message, and Collection. It would not normally be populated for search and history results and servers ignore Bundle.identifier when processing batches and transactions. For Documents the .identifier SHALL be populated such that the .identifier is globally unique.; (xsd)identifier:Identifier>?
< Indicates the purpose of this bundle - how it is intended to be used. It's possible to use a bundle for other purposes (e.g. a document can be accepted as a transaction). This is primarily defined so that there can be specific rules for some of the bundle types. Binding: bundle-type (required, Indicates the purpose of a bundle - how it is intended to be used.); (xsd)type:code>
< The date/time that the bundle was assembled - i.e. when the resources were placed in the bundle. For many bundles, the timestamp is equal to .meta.lastUpdated, because they are not stored (e.g. search results). When a bundle is placed in a persistent store, .meta.lastUpdated will be usually be changed by the server. When the bundle is a message, a middleware agent altering the message (even if not stored) SHOULD update .meta.lastUpdated. .timestamp is used to track the original time of the Bundle, and SHOULD be populated.
Usage:
* document : the date the document was created. Note: the composition may predate the document, or be associated with multiple documents. The date of the composition - the authoring time - may be earlier than the document assembly time
* message : the date that the content of the message was assembled. This date is not changed by middleware engines unless they add additional data that changes the meaning of the time of the message
* history : the date that the history was assembled. This time would be used as the _since time to ask for subsequent updates
* searchset : the time that the search set was assembled. Note that different pages MAY have different timestamps but need not. Having different timestamps does not imply that subsequent pages will represent or include changes made since the initial query
* transaction | transaction-response | batch | batch-response | collection : no particular assigned meaning
The timestamp value should be greater than the lastUpdated and other timestamps in the resources in the bundle, and it should be equal or earlier than the .meta.lastUpdated on the Bundle itself.; (xsd)timestamp:instant>?
< If a set of search matches, this is the (potentially estimated) total number of entries of type 'match' across all pages in the search. It does not include search.mode = 'include' or 'outcome' entries and it does not provide a count of the number of entries in the Bundle. Only used if the bundle is a search result set. The total does not include resources such as OperationOutcome and included resources, only the total number of matching resources.; (xsd)total:unsignedInt>?
[]< A series of links that provide context to this bundle. Both Bundle.link and Bundle.entry.link are defined to support providing additional context when Bundles are used (e.g. [HATEOAS](http://en.wikipedia.org/wiki/HATEOAS)).
Bundle.entry.link corresponds to links found in the HTTP header if the resource in the entry was [read](http.html#read) directly.
This specification defines some specific uses of Bundle.link for [searching](search.html#conformance) and [paging](http.html#paging), but no specific uses for Bundle.entry.link, and no defined function in a transaction - the meaning is implementation specific. The behavior of navigation link types (next/prev/first/last) are well defined for searchset and history Bundles but are not currently defined for other types. Implementers who choose to use such link relationships for other bundle types will need to negotiate behavior with their interoperability partners.; (xsd)link:Bundle.link>*
[]< An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).; (xsd)entry:Bundle.entry>*
< Digital Signature - base64 encoded. XML-DSig or a JWS. The signature could be created by the "author" of the bundle or by the originating device. Requirements around inclusion of a signature, verification of signatures and treatment of signed/non-signed bundles is implementation-environment specific.; (xsd)signature:Signature>?
< Captures issues and warnings that relate to the construction of the Bundle and the content within it. Usage notes: These issues and warnings must apply to the Bundle as a whole, not to individual entries.Messages relating to the processing of individual entries (e.g. in a batch or transaction) SHALL be reported in the entry.response.outcome for that entry. If there are errors that arise in the creation of the Bundle, then that should be handled by an OperationOutcome being returned instead of the Bundle.; (xsd)issues:OperationOutcome>?🔗 An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).Bundle.entry(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< A series of links that provide context to this entry.; (xsd)link:Bundle.link>*
< The Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when:
* invoking a create
* invoking or responding to an operation where the body is not a single identified resource
* invoking or returning the results of a search or history operation. fullUrl might not be [unique in the context of a resource](bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](references.html), the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the [regex](references.html#regex), then the 'id' portion of the fullUrl SHALL end with the Resource.id.
Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).; (xsd)fullUrl:uri>?
< The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. This is allowed to be a Parameters resource if and only if it is referenced by something else within the Bundle that provides context/meaning.; (xsd)resource:Resource>?
< Information about the search process that lead to the creation of this entry.; (xsd)search:Bundle.entry.search>?
< Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.; (xsd)request:Bundle.entry.request>?
< Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.; (xsd)response:Bundle.entry.response>?🔗 Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.Bundle.entry.request(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred. Binding: http-verb (required, HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details.); (xsd)method:code>
< The URL for this entry, relative to the root (the address to which the request is posted). E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]".; (xsd)url:uri>
< If the ETag values match, return a 304 Not Modified status. See the API documentation for ["Conditional Read"](http.html#cread).; (xsd)ifNoneMatch:string>?
< Only perform the operation if the last updated date matches. See the API documentation for ["Conditional Read"](http.html#cread).; (xsd)ifModifiedSince:instant>?
< Only perform the operation if the Etag value matches. For more information, see the API section ["Managing Resource Contention"](http.html#concurrency).; (xsd)ifMatch:string>?
< Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for ["Conditional Create"](http.html#ccreate). This is just the query portion of the URL - what follows the "?" (not including the "?").; (xsd)ifNoneExist:string>?🔗 Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.Bundle.entry.response(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.; (xsd)status:string>
< The location header created by processing this operation, populated if the operation returns a location.; (xsd)location:uri>?
< The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)). Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.; (xsd)etag:string>?
< The date/time that the resource was modified on the server. This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.; (xsd)lastModified:instant>?
< An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction. For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.
This outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.; (xsd)outcome:Resource>?🔗 Information about the search process that lead to the creation of this entry.Bundle.entry.search(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence. Binding: search-entry-mode (required, Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.); (xsd)mode:code>?
< When searching, the server's search ranking score for the entry. Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.
See [Patient Match](patient-operation-match.html) for the EMPI search which relates to this element.; (xsd)score:decimal>?🔗 A series of links that provide context to this bundle. Both Bundle.link and Bundle.entry.link are defined to support providing additional context when Bundles are used (e.g. [HATEOAS](http://en.wikipedia.org/wiki/HATEOAS)).
Bundle.entry.link corresponds to links found in the HTTP header if the resource in the entry was [read](http.html#read) directly.
This specification defines some specific uses of Bundle.link for [searching](search.html#conformance) and [paging](http.html#paging), but no specific uses for Bundle.entry.link, and no defined function in a transaction - the meaning is implementation specific. The behavior of navigation link types (next/prev/first/last) are well defined for searchset and history Bundles but are not currently defined for other types. Implementers who choose to use such link relationships for other bundle types will need to negotiate behavior with their interoperability partners.Bundle.link(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A name which details the functional use for this link - see [http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1](http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1). Binding: iana-link-relations (required, ); (xsd)relation:code>
< The reference details for the link.; (xsd)url:uri>🔗 A URI that is a reference to a canonical URL on a FHIR resource see [Canonical References](references.html#canonical)canonical(xsd)(doc)=
<#base:uri>
< unique id for the element within a resource (for internal references); (xsd)id:string>?
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< Primitive value for canonical; (xsd)value:string>?🔗 Common Interface declaration for conformance and knowledge artifact resources.CanonicalResource(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< An absolute URI that is used to identify this {{title}} when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this {{title}} is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the {{title}} is stored on different servers. Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.
The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions).
In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.; (xsd)url:uri>?
[]< A formal identifier that is used to identify this {{title}} when it is represented in other formats, or referenced in a specification, model, design or an instance. Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this {{title}} outside of FHIR, where it is not possible to use the logical URI.; (xsd)identifier:Identifier>*
< The identifier that is used to identify this version of the {{title}} when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the {{title}} author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence without additional knowledge. (See the versionAlgorithm element.) There may be different {{title}}s that have the same url but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the {{title}} with the format [url]|[version]. The version SHOULD NOT contain a '#' - see [Business Version](resource.html#bv-format).; (xsd)version:string>?
< Indicates the mechanism used to compare versions to determine which is more current. If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined. Binding: version-algorithm (extensible, ); (xsd)versionAlgorithm:(<Coding>
|<string>)>?
< A natural language name identifying the {{title}}. This name should be usable as an identifier for the resource by machine processing applications such as code generation. The name is not expected to be globally unique. The name should be a simple alphanumeric type no-whitespace name to ensure that it is machine-processing friendly.; (xsd)name:string>?
< A short, descriptive, user-friendly title for the {{title}}. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.; (xsd)title:string>?
< The current state of this {{title}}. A nominal state-transition diagram can be found in the [Definition pattern](definition.html#statemachine) documentation.
Unknown does not represent 'other' - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization). Binding: publication-status (required, The lifecycle status of an artifact.); (xsd)status:code>
< A Boolean value to indicate that this {{title}} is authored for testing purposes (or education/evaluation/marketing) and is not intended for genuine usage. Allows filtering of {{title}}s that are appropriate for use versus not.; (xsd)experimental:boolean>?
< The date (and optionally time) when the {{title}} was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the {{title}} changes. The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the {{title}}. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)date:dateTime>?
< The name of the organization or individual responsible for the release and ongoing maintenance of the {{title}}. Usually an organization but may be an individual. The publisher (or steward) of the {{title}} is the organization or individual primarily responsible for the maintenance and upkeep of the {{title}}. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the {{title}}. This item SHOULD be populated unless the information is available from context.; (xsd)publisher:string>?
[]< Contact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)contact:ContactDetail>*
< A free text natural language description of the {{title}} from a consumer's perspective. This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the {{title}} as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context.; (xsd)description:markdown>?
[]< The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate {{title}}s. When multiple useContexts are specified, there is no expectation that all or even any of the contexts apply.; (xsd)useContext:UsageContext>*
[]< A legal or geographic region in which the {{title}} is intended to be used. It may be possible for the {{title}} to be used in jurisdictions other than those for which it was originally designed or intended.
DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.) Binding: jurisdiction (extensible, Countries and regions within which this artifact is targeted for use.); (xsd)jurisdiction:CodeableConcept>*
< Explanation of why this {{title}} is needed and why it has been designed as it has. This element does not describe the usage of the {{title}}. Instead, it provides traceability of "why" the resource is either needed or "why" it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this {{title}}.; (xsd)purpose:markdown>?
< A copyright statement relating to the {{title}} and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the {{title}}. The short copyright declaration (e.g. (c) '2015+ xyz organization' should be sent in the copyrightLabel element.; (xsd)copyright:markdown>?
< A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved'). The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.; (xsd)copyrightLabel:string>?🔗 A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server or Client for a particular version of FHIR that may be used as a statement of actual server functionality or a statement of required or desired server implementation. Applications may implement multiple versions (see [Managing Multiple Versions](versioning.html), and the [$versions](capabilitystatement-operation-versions.html) operation). If they do, then a CapabilityStatement describes the system's support for a particular version of FHIR, and the server will have multiple statements, one for each version.CapabilityStatement(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< An absolute URI that is used to identify this capability statement when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this capability statement is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the capability statement is stored on different servers. Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.
The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions).
In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.; (xsd)url:uri>?
[]< A formal identifier that is used to identify this CapabilityStatement when it is represented in other formats, or referenced in a specification, model, design or an instance.; (xsd)identifier:Identifier>*
< The identifier that is used to identify this version of the capability statement when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the capability statement author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. There may be different capability statement instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the capability statement with the format [url]|[version]. The version SHOULD NOT contain a '#' - see [Business Version](resource.html#bv-format).; (xsd)version:string>?
< Indicates the mechanism used to compare versions to determine which is more current. If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined. Binding: version-algorithm (extensible, ); (xsd)versionAlgorithm:(<Coding>
|<string>)>?
< A natural language name identifying the capability statement. This name should be usable as an identifier for the module by machine processing applications such as code generation. The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.; (xsd)name:string>?
< A short, descriptive, user-friendly title for the capability statement. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.; (xsd)title:string>?
< The status of this capability statement. Enables tracking the life-cycle of the content. Allows filtering of capability statements that are appropriate for use versus not.This is not intended for use with actual capability statements, but where capability statements are used to describe possible or desired systems.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization). Binding: publication-status (required, The lifecycle status of an artifact.); (xsd)status:code>
< A Boolean value to indicate that this capability statement is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. Allows filtering of capability statements that are appropriate for use versus not.; (xsd)experimental:boolean>?
< The date (and optionally time) when the capability statement was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the capability statement changes. The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the capability statement. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)date:dateTime>
< The name of the organization or individual responsible for the release and ongoing maintenance of the capability statement. Usually an organization but may be an individual. The publisher (or steward) of the capability statement is the organization or individual primarily responsible for the maintenance and upkeep of the capability statement. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the capability statement. This item SHOULD be populated unless the information is available from context.; (xsd)publisher:string>?
[]< Contact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)contact:ContactDetail>*
< A free text natural language description of the capability statement from a consumer's perspective. Typically, this is used when the capability statement describes a desired rather than an actual solution, for example as a formal expression of requirements as part of an RFP. This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the capability statement as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the capability statement is presumed to be the predominant language in the place the capability statement was created).This does not need to be populated if the description is adequately implied by the software or implementation details.; (xsd)description:markdown>?
[]< The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate capability statement instances. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.; (xsd)useContext:UsageContext>*
[]< A legal or geographic region in which the capability statement is intended to be used. It may be possible for the capability statement to be used in jurisdictions other than those for which it was originally designed or intended.
DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.) Binding: jurisdiction (extensible, Countries and regions within which this artifact is targeted for use.); (xsd)jurisdiction:CodeableConcept>*
< Explanation of why this capability statement is needed and why it has been designed as it has. This element does not describe the usage of the capability statement. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this capability statement.; (xsd)purpose:markdown>?
< A copyright statement relating to the capability statement and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the capability statement. ...; (xsd)copyright:markdown>?
< A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved'). The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.; (xsd)copyrightLabel:string>?
< The way that this statement is intended to be used, to describe an actual running instance of software, a particular product (kind, not instance of software) or a class of implementation (e.g. a desired purchase). Binding: capability-statement-kind (required, How a capability statement is intended to be used.); (xsd)kind:code>
[]< Reference to a canonical URL of another CapabilityStatement that this software implements. This capability statement is a published API description that corresponds to a business service. The server may actually implement a subset of the capability statement it claims to implement, so the capability statement must specify the full capability details. HL7 defines the following Services: [Terminology Service](terminology-service.html).
Many [Implementation Guides](http://fhir.org/guides/registry) define additional services.; (xsd)instantiates:CapabilityStatement*>*
[]< Reference to a canonical URL of another CapabilityStatement that this software adds to. The capability statement automatically includes everything in the other statement, and it is not duplicated, though the server may repeat the same resources, interactions and operations to add additional details to them. the contents of any directly or indirectly imported CapabilityStatements SHALL NOT overlap, i.e. they cannot refer to the same rest/resource, operations/name, searchparam/name, interaction/code, messaging/endpoint, document/mode pair.
A capability statement that imports another CapabilityStatement automatically instantiates it too (though this is often not a very useful statement for the kinds of CapabilityStatements that are suitable for importing).; (xsd)imports:CapabilityStatement*>*
< Software that is covered by this capability statement. It is used when the capability statement describes the capabilities of a particular software version, independent of an installation.; (xsd)software:CapabilityStatement.software>?
< Identifies a specific implementation instance that is described by the capability statement - i.e. a particular installation, rather than the capabilities of a software program.; (xsd)implementation:CapabilityStatement.implementation>?
< The version of the FHIR specification that this CapabilityStatement describes (which SHALL be the same as the FHIR version of the CapabilityStatement itself). There is no default value. Servers may implement multiple versions (see [Managing Multiple Versions](versioning.html), and the [$versions](capabilitystatement-operation-versions.html) operation). If they do, and the CapabilityStatement is requested from the server, then this fhirVersion will be either the version requested, or the server's default version. Binding: FHIR-version (required, All published FHIR Versions.); (xsd)fhirVersion:code>
[]< A list of the formats supported by this implementation using their content types. "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. Binding: mimetypes (required, The mime type of an attachment. Any valid mime type is allowed.); (xsd)format:code>+
[]< A list of the patch formats supported by this implementation using their content types. At present, the patch mime types application/json-patch+json and application/xml-patch+xml are legal. Generally, if a server supports PATCH, it would be expected to support the patch formats and match the formats it supports, but this is not always possible or necessary. Binding: mimetypes (required, BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)); (xsd)patchFormat:code>*
[]< A list of the languages supported by this implementation that are usefully supported in the ```Accept-Language``` header. In general, if a server gets a request with an Accept-Language that it doesn't support, it should still reutrn the resource, just in its default language for the resource. Binding: all-languages (required, IETF language tag for a human language); (xsd)acceptLanguage:code>*
[]< A list of implementation guides that the server does (or should) support in their entirety. Note: this is primarily only relevant in terms of ImplementationGuides that don't define specific CapabilityStatements declaring the expectation of distinct roles. (E.g. generic IGs that establish privacy policies.) In situations where an ImplementationGuide does define CapabilityStatements, asserting CapabilityStatement.implementationGuide means that the implementation adheres to any Implementation.global definitions present in that IG as well as any textual requirements around security or other general interoperability behaviors. However, it does not make any assertions as to conformance with any of the CapabilityStatements defined in the IG. To assert conformance with CapabilityStatements in a referenced IG, it is necessary to use the CapabilityStatement.instantiates element.; (xsd)implementationGuide:ImplementationGuide*>*
[]< A definition of the restful capabilities of the solution, if any. Multiple repetitions allow definition of both client and/or server behaviors or possibly behaviors under different configuration settings (for software or requirements statements).; (xsd)rest:CapabilityStatement.rest>*
[]< A description of the messaging capabilities of the solution. Multiple repetitions allow the documentation of multiple endpoints per solution.; (xsd)messaging:CapabilityStatement.messaging>*
[]< A document definition.; (xsd)document:CapabilityStatement.document>*🔗 A document definition.CapabilityStatement.document(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Mode of this document declaration - whether an application is a producer or consumer. Binding: document-mode (required, Whether the application produces or consumes documents.); (xsd)mode:code>
< A description of how the application supports or uses the specified document profile. For example, when documents are created, what action is taken with consumed documents, etc.; (xsd)documentation:markdown>?
< A profile on the document Bundle that constrains which resources are present, and their contents. The profile is actually on the Bundle.; (xsd)profile:StructureDefinition*>🔗 Identifies a specific implementation instance that is described by the capability statement - i.e. a particular installation, rather than the capabilities of a software program.CapabilityStatement.implementation(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Information about the specific installation that this capability statement relates to.; (xsd)description:markdown>
< An absolute base URL for the implementation. This forms the base for REST interfaces as well as the mailbox and document interfaces.; (xsd)url>?
< The organization responsible for the management of the instance and oversight of the data on the server at the specified URL.; (xsd)custodian:Organization*>?🔗 A description of the messaging capabilities of the solution. Multiple repetitions allow the documentation of multiple endpoints per solution.CapabilityStatement.messaging(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< An endpoint (network accessible address) to which messages and/or replies are to be sent.; (xsd)endpoint:CapabilityStatement.messaging.endpoint>*
< Length if the receiver's reliable messaging cache in minutes (if a receiver) or how long the cache length on the receiver should be (if a sender). If this value is missing then the application does not implement (receiver) or depend on (sender) reliable messaging.; (xsd)reliableCache:unsignedInt>?
< Documentation about the system's messaging capabilities for this endpoint not otherwise documented by the capability statement. For example, the process for becoming an authorized messaging exchange partner.; (xsd)documentation:markdown>?
[]< References to message definitions for messages this system can send or receive. This is a proposed alternative to the messaging.event structure.; (xsd)supportedMessage:CapabilityStatement.messaging.supportedMessage>*🔗 An endpoint (network accessible address) to which messages and/or replies are to be sent.CapabilityStatement.messaging.endpoint(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A list of the messaging transport protocol(s) identifiers, supported by this endpoint. Binding: message-transport (extensible, The protocol used for message transport.); (xsd)protocol:Coding>
< The network address of the endpoint. For solutions that do not use network addresses for routing, it can be just an identifier.; (xsd)address:url>🔗 References to message definitions for messages this system can send or receive. This is a proposed alternative to the messaging.event structure.CapabilityStatement.messaging.supportedMessage(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The mode of this event declaration - whether application is sender or receiver. Binding: event-capability-mode (required, The mode of a message capability statement.); (xsd)mode:code>
< Points to a message definition that identifies the messaging event, message structure, allowed responses, etc.; (xsd)definition:MessageDefinition*>🔗 A definition of the restful capabilities of the solution, if any. Multiple repetitions allow definition of both client and/or server behaviors or possibly behaviors under different configuration settings (for software or requirements statements).CapabilityStatement.rest(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Identifies whether this portion of the statement is describing the ability to initiate or receive restful operations. Binding: restful-capability-mode (required, The mode of a RESTful capability statement.); (xsd)mode:code>
< Information about the system's restful capabilities that apply across all applications, such as security.; (xsd)documentation:markdown>?
< Information about security implementation from an interface perspective - what a client needs to know.; (xsd)security:CapabilityStatement.rest.security>?
[]< A specification of the restful capabilities of the solution for a specific resource type. Max of one repetition per resource type.; (xsd)resource:CapabilityStatement.rest.resource>*
[]< A specification of restful operations supported by the system.; (xsd)interaction:CapabilityStatement.rest.interaction>*
[]< Search parameters that are supported for searching all resources for implementations to support and/or make use of - either references to ones defined in the specification, or additional ones defined for/by the implementation. This is only for searches executed against the system-level endpoint. Typically, the only search parameters supported for all searches are those that apply to all resources - tags, profiles, text search etc. These search parameters should include the control search parameters such as _sort, _count, etc. that also apply to this resource (though many will be listed at [CapabilityStatement.rest.searchParam](capabilitystatement-definitions.html#CapabilityStatement.rest.searchParam)). The behavior of some search parameters may be further described by other code or extension elements, or narrative within the capability statement or linked [SearchParameter](searchparameter.html#) definitions.; (xsd)searchParam:CapabilityStatement.rest.resource.searchParam>*
[]< Definition of an operation or a named query together with its parameters and their meaning and type. CapabilityStatement.rest.operation is for operations invoked at the system level, or for operations that are supported across multiple resource types. Operations linked from CapabilityStatement.rest.operation must have OperationDefinition.system = true, or more than one Operation.resource.; (xsd)operation:CapabilityStatement.rest.resource.operation>*
[]< An absolute URI which is a reference to the definition of a compartment that the system supports. The reference is to a CompartmentDefinition resource by its canonical URL . At present, the only defined compartments are at [CompartmentDefinition](compartmentdefinition.html).; (xsd)compartment:CompartmentDefinition*>*🔗 A specification of restful operations supported by the system.CapabilityStatement.rest.interaction(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A coded identifier of the operation, supported by the system. Binding: system-restful-interaction (required, Operations supported by REST at the system level.); (xsd)code>
< Guidance specific to the implementation of this operation, such as limitations on the kind of transactions allowed, or information about system wide search is implemented.; (xsd)documentation:markdown>?🔗 A specification of the restful capabilities of the solution for a specific resource type. Max of one repetition per resource type.CapabilityStatement.rest.resource(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A type of resource exposed via the restful interface. Binding: resource-types (required, One of the resource types defined as part of this version of FHIR.); (xsd)type:code>
< A system-wide profile that is applied across *all* instances of the resource supported by the system. For example, if declared on Observation, this profile is the "superset" of capabilities for laboratory *and* vitals *and* other domains. See further discussion in [Using Profiles](profiling.html#profile-uses). All other profiles for this type that are listed in `.rest.resource.supportedProfile` must conform to this profile.; (xsd)profile:StructureDefinition*>?
[]< A list of profiles representing different use cases the system hosts/produces. A supported profile is a statement about the functionality of the data and services provided by the server (or the client) for supported use cases. For example, a system can define and declare multiple Observation profiles for laboratory observations, vital sign observations, etc. By declaring supported profiles, systems provide a way to determine whether individual resources are conformant. See further discussion in [Using Profiles](profiling.html#profile-uses). Supported profiles must conform to the resource profile in the `.rest.resource.profile` element if it is present. The resource profile is a system-wide profile applied across *all* instances of the resource supported by the system. A supported profile is a statement about the functionality of the data and services provided by the server (or used by the client) for a particular set of use cases and will not necessarily apply to all data consumed or exposed by the server.; (xsd)supportedProfile:StructureDefinition*>*
< Additional information about the resource type used by the system.; (xsd)documentation:markdown>?
[]< Identifies a restful operation supported by the solution. In general, a Resource will only appear in a CapabilityStatement if the server actually has some capabilities - e.g. there is at least one interaction supported. However interactions can be omitted to support summarization (_summary = true).; (xsd)interaction:CapabilityStatement.rest.resource.interaction>*
< This field is set to no-version to specify that the system does not support (server) or use (client) versioning for this resource type. If this has some other value, the server must at least correctly track and populate the versionId meta-property on resources. If the value is 'versioned-update', then the server supports all the versioning features, including using e-tags for version integrity in the API. If a server supports versionIds correctly, it SHOULD support vread too, but is not required to do so. Binding: versioning-policy (required, How the system supports versioning for a resource.); (xsd)versioning:code>?
< A flag for whether the server is able to return past versions as part of the vRead operation. It is useful to support the vRead operation for current operations, even if past versions aren't available.; (xsd)readHistory:boolean>?
< A flag to indicate that the server allows or needs to allow the client to create new identities on the server (that is, the client PUTs to a location where there is no existing resource). Allowing this operation means that the server allows the client to create new identities on the server. Allowing the clients to create new identities on the server means that the system administrator needs to have confidence that the clients do not create clashing identities between them. Obviously, if there is only one client, this won't happen. While creating identities on the client means that the clients need to be managed, it's much more convenient for many scenarios if such management can be put in place.; (xsd)updateCreate:boolean>?
< A flag that indicates that the server supports conditional create. Conditional Create is mainly appropriate for interface engine scripts converting from other formats, such as v2.; (xsd)conditionalCreate:boolean>?
< A code that indicates how the server supports conditional read. Conditional Read is mainly appropriate for interface engine scripts converting from other formats, such as v2. Binding: conditional-read-status (required, A code that indicates how the server supports conditional read.); (xsd)conditionalRead:code>?
< A flag that indicates that the server supports conditional update. Conditional Update is mainly appropriate for interface engine scripts converting from other formats, such as v2.; (xsd)conditionalUpdate:boolean>?
< A flag that indicates that the server supports conditional patch. Conditional Patch is mainly appropriate for interface engine scripts converting from other formats, such as v2.; (xsd)conditionalPatch:boolean>?
< A code that indicates how the server supports conditional delete. Conditional Delete is mainly appropriate for interface engine scripts converting from other formats, such as v2. Binding: conditional-delete-status (required, A code that indicates how the server supports conditional delete.); (xsd)conditionalDelete:code>?
[]< A set of flags that defines how references are supported. Binding: reference-handling-policy (required, A set of flags that defines how references are supported.); (xsd)referencePolicy:code>*
[]< A list of _include values supported by the server. Documenting [`_include`](http://hl7.org/fhir/R5/search.html#revinclude) support helps set conformance expectations for the desired system. Still, it is a level of detail that might not be exposed by production servers or clients when using CapabilityStatement to describe an actual implementation. If this list is empty, the server does not support includes. Support for *iterative* (a.k.a., recursive) `_include` is communicated by listing the iterative includes values supported by the server in the `searchInclude` element of the "root" resource type. For example, to support the following search:
`GET [base]/CarePlan?_include=CarePlan:activity-reference:DeviceRequest&_include:iterate=DeviceRequest:device`
These values would be listed as part of capabilities for "CarePlan":
"searchInclude" : ["CarePlan:activity-reference:DeviceRequest","DeviceRequest:device"],
; (xsd)searchInclude:string>*
[]< A list of _revinclude (reverse include) values supported by the server. See `CapabilityStatement.rest.resource.searchInclude` comments.; (xsd)searchRevInclude:string>*
[]< Search parameters for implementations to support and/or make use of - either references to ones defined in the specification, or additional ones defined for/by the implementation. The search parameters should include the control search parameters such as _sort, _count, etc. that also apply to this resource (though many will be listed at [CapabilityStatement.rest.searchParam](capabilitystatement-definitions.html#CapabilityStatement.rest.searchParam)). The behavior of some search parameters may be further described by other code or extension elements, or narrative within the capability statement or linked [SearchParameter](searchparameter.html#) definitions.; (xsd)searchParam:CapabilityStatement.rest.resource.searchParam>*
[]< Definition of an operation or a named query together with its parameters and their meaning and type. Consult the definition of the operation for details about how to invoke the operation, and the parameters. Operations linked from CapabilityStatement.rest.resource.operation must have OperationDefinition.type = true or OperationDefinition.instance = true.
If an operation that is listed in multiple CapabilityStatement.rest.resource.operation (e.g. for different resource types), then clients should understand that the operation is only supported on the specified resource types, and that may be a subset of those listed in OperationDefinition.resource.; (xsd)operation:CapabilityStatement.rest.resource.operation>*🔗 Identifies a restful operation supported by the solution. In general, a Resource will only appear in a CapabilityStatement if the server actually has some capabilities - e.g. there is at least one interaction supported. However interactions can be omitted to support summarization (_summary = true).CapabilityStatement.rest.resource.interaction(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Coded identifier of the operation, supported by the system resource. Binding: type-restful-interaction (required, Operations supported by REST at the type or instance level.); (xsd)code>
< Guidance specific to the implementation of this operation, such as 'delete is a logical delete' or 'updates are only allowed with version id' or 'creates permitted from pre-authorized certificates only'.; (xsd)documentation:markdown>?🔗 Definition of an operation or a named query together with its parameters and their meaning and type. Consult the definition of the operation for details about how to invoke the operation, and the parameters. Operations linked from CapabilityStatement.rest.resource.operation must have OperationDefinition.type = true or OperationDefinition.instance = true.
If an operation that is listed in multiple CapabilityStatement.rest.resource.operation (e.g. for different resource types), then clients should understand that the operation is only supported on the specified resource types, and that may be a subset of those listed in OperationDefinition.resource.CapabilityStatement.rest.resource.operation(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The name of the operation or query. For an operation, this name is prefixed with $ and used in the URL. For a query, this is the name used in the _query parameter when the query is called. This SHOULD be the same as the OperationDefinition.code of the defining OperationDefinition. However, it can sometimes differ if necessary to disambiguate when a server supports multiple OperationDefinition that happen to share the same code. The name here SHOULD be the same as the OperationDefinition.code in the referenced OperationDefinition, unless there is a name clash and the OperationDefinition.code cannot be used. The name does not include the "$" portion that is always included in the URL. There is no correspondence whatsoever between CapabilityStatement's operation.name and OperationDefinition.name - the latter is used as a class name when generating code for the operation. HL7 will never define operations that have conflicting names.; (xsd)name:string>
< Where the formal definition can be found. If a server references the base definition of an Operation (i.e. from the specification itself such as ```http://hl7.org/fhir/OperationDefinition/ValueSet-expand```), that means it supports the full capabilities of the operation - e.g. both GET and POST invocation. If it only supports a subset, it must define its own custom [OperationDefinition](operationdefinition.html#) with a 'base' of the original OperationDefinition. The custom definition would describe the specific subset of functionality supported. This can be used to build an HTML form to invoke the operation, for instance.; (xsd)definition:OperationDefinition*>
< Documentation that describes anything special about the operation behavior, possibly detailing different behavior for system, type and instance-level invocation of the operation.; (xsd)documentation:markdown>?🔗 Search parameters for implementations to support and/or make use of - either references to ones defined in the specification, or additional ones defined for/by the implementation. The search parameters should include the control search parameters such as _sort, _count, etc. that also apply to this resource (though many will be listed at [CapabilityStatement.rest.searchParam](capabilitystatement-definitions.html#CapabilityStatement.rest.searchParam)). The behavior of some search parameters may be further described by other code or extension elements, or narrative within the capability statement or linked [SearchParameter](searchparameter.html#) definitions.CapabilityStatement.rest.resource.searchParam(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The label used for the search parameter in this particular system's API - i.e. the 'name' portion of the name-value pair that will appear as part of the search URL. This SHOULD be the same as the SearchParameter.code of the defining SearchParameter. However, it can sometimes differ if necessary to disambiguate when a server supports multiple SearchParameters that happen to share the same code. Parameter names cannot overlap with standard parameter names, and standard parameters cannot be redefined. There is no correspondence whatsoever between CapabilityStatement's searchParam.name and SearchParameter.name - the latter is used as a class name when generating code for the search parameter.; (xsd)name:string>
< An absolute URI that is a formal reference to where this parameter was first defined, so that a client can be confident of the meaning of the search parameter (a reference to [SearchParameter.url](searchparameter-definitions.html#SearchParameter.url)). This element SHALL be populated if the search parameter refers to a SearchParameter defined by the FHIR core specification or externally defined IGs. This SHOULD be present, and matches refers to a SearchParameter by its canonical URL. If systems wish to document their support for modifiers, comparators, target resource types, and chained parameters, they should do using a search parameter resource. This element SHALL be populated if the search parameter refers to a SearchParameter defined by the FHIR core specification or externally defined IGs.; (xsd)definition:SearchParameter*>?
< The type of value a search parameter refers to, and how the content is interpreted. While this can be looked up from the definition, it is included here as a convenience for systems that autogenerate a query interface based on the server capability statement. It SHALL be the same as the type in the search parameter definition. Binding: search-param-type (required, Data types allowed to be used for search parameters.); (xsd)type:code>
< This allows documentation of any distinct behaviors about how the search parameter is used. For example, text matching algorithms.; (xsd)documentation:markdown>?🔗 Information about security implementation from an interface perspective - what a client needs to know.CapabilityStatement.rest.security(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Server adds CORS headers when responding to requests - this enables Javascript applications to use the server. The easiest CORS headers to add are Access-Control-Allow-Origin: * & Access-Control-Request-Method: GET, POST, PUT, DELETE. All servers SHOULD support CORS.; (xsd)cors:boolean>?
[]< Types of security services that are supported/required by the system. Binding: restful-security-service (extensible, Types of security services used with FHIR.); (xsd)service:CodeableConcept>*
< General description of how security works.; (xsd)description:markdown>?🔗 Software that is covered by this capability statement. It is used when the capability statement describes the capabilities of a particular software version, independent of an installation.CapabilityStatement.software(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Name the software is known by.; (xsd)name:string>
< The version identifier for the software covered by this statement. If possible, a version should be specified, as statements are likely to be different for different versions of software.; (xsd)version:string>?
< Date this version of the software was released.; (xsd)releaseDate:dateTime>?🔗 Describes the intention of how one or more practitioners intend to deliver care for a particular patient, group or community for a period of time, possibly limited to care for a specific condition or set of conditions.CarePlan(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< Business identifiers assigned to this care plan by the performer or other systems which remain constant as the resource is updated and propagates from server to server. This is a business identifier, not a resource identifier (see [discussion](resource.html#identifiers)). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.; (xsd)identifier:Identifier>*
[]< The URL pointing to a FHIR-defined protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan.; (xsd)instantiatesCanonical:(<ActivityDefinition>
|<Measure>
|<OperationDefinition>
|<PlanDefinition>
|<Questionnaire>)>*
[]< The URL pointing to an externally maintained protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan. This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.; (xsd)instantiatesUri:uri>*
[]< A higher-level request resource (i.e. a plan, proposal or order) that is fulfilled in whole or in part by this care plan.; (xsd)basedOn:(<CarePlan>
|<NutritionOrder>
|<RequestOrchestration>
|<ServiceRequest>)>*
[]< Completed or terminated care plan whose function is taken by this new care plan. The replacement could be because the initial care plan was immediately rejected (due to an issue) or because the previous care plan was completed, but the need for the action described by the care plan remains ongoing.; (xsd)replaces:CarePlan*>*
[]< A larger care plan of which this particular care plan is a component or step. Each care plan is an independent request, such that having a care plan be part of another care plan can cause issues with cascading statuses. As such, this element is still being discussed.; (xsd)partOf:CarePlan*>*
< Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record. The unknown code is not to be used to convey other statuses. The unknown code should be used when one of the statuses applies, but the authoring system doesn't know the current state of the care plan.
This element is labeled as a modifier because the status contains the code entered-in-error that marks the plan as not currently valid. Binding: request-status (required, Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.); (xsd)status:code>
< Indicates the level of authority/intentionality associated with the care plan and where the care plan fits into the workflow chain. This element is labeled as a modifier because the intent alters when and how the resource is actually applicable.
This element is expected to be immutable. E.g. A "proposal" instance should never change to be a "plan" instance or "order" instance. Instead, a new instance 'basedOn' the prior instance should be created with the new 'intent' value. Binding: care-plan-intent (required, Codes indicating the degree of authority/intentionality associated with a care plan.); (xsd)intent:code>
[]< Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", "wellness plan", etc. There may be multiple axes of categorization and one plan may serve multiple purposes. In some cases, this may be redundant with references to CarePlan.addresses. Binding: care-plan-category (example, Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", etc.); (xsd)category:CodeableConcept>*
< Human-friendly name for the care plan.; (xsd)title:string>?
< A description of the scope and nature of the plan.; (xsd)description:string>?
< Identifies the patient or group whose intended care is described by the plan.; (xsd)subject:(<Group>
|<Patient>)>
< The Encounter during which this CarePlan was created or to which the creation of this record is tightly associated. This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter. CarePlan activities conducted as a result of the care plan may well occur as part of other encounters.; (xsd)encounter:Encounter*>?
< Indicates when the plan did (or is intended to) come into effect and end. Any activities scheduled as part of the plan should be constrained to the specified period regardless of whether the activities are planned within a single encounter/episode or across multiple encounters/episodes (e.g. the longitudinal management of a chronic condition).; (xsd)period:Period>?
< Represents when this particular CarePlan record was created in the system, which is often a system-generated date.; (xsd)created:dateTime>?
< When populated, the custodian is responsible for the care plan. The care plan is attributed to the custodian. The custodian might or might not be a contributor.; (xsd)custodian:(<CareTeam>
|<Device>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>?
[]< Identifies the individual(s), organization or device who provided the contents of the care plan. Collaborative care plans may have multiple contributors.; (xsd)contributor:(<CareTeam>
|<Device>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>*
[]< Identifies all people and organizations who are expected to be involved in the care envisioned by this plan.; (xsd)careTeam:CareTeam*>*
[]< Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan. Use CarePlan.addresses.concept when a code sufficiently describes the concern (e.g. condition, problem, diagnosis, risk). Use CarePlan.addresses.reference when referencing a resource, which allows more information to be conveyed, such as onset date. CarePlan.addresses.concept and CarePlan.addresses.reference are not meant to be duplicative. For a single concern, either CarePlan.addresses.concept or CarePlan.addresses.reference can be used. CarePlan.addresses.concept may be a summary code, or CarePlan.addresses.reference may be used to reference a very precise definition of the concern using Condition. Both CarePlan.addresses.concept and CarePlan.addresses.reference can be used if they are describing different concerns for the care plan. Binding: clinical-findings (example, Codes that describe the health issues this plan addresses.); (xsd)addresses:Condition*>*
[]< Identifies portions of the patient's record that specifically influenced the formation of the plan. These might include comorbidities, recent procedures, limitations, recent assessments, etc. Use "concern" to identify specific conditions addressed by the care plan. supportingInfo can be used to convey one or more Advance Directives or Medical Treatment Consent Directives by referencing Consent or any other request resource with intent = directive.; (xsd)supportingInfo:Resource*>*
[]< Describes the intended objective(s) of carrying out the care plan. Goal can be achieving a particular change or merely maintaining a current state or even slowing a decline.; (xsd)goal:Goal*>*
[]< Identifies an action that has occurred or is a planned action to occur as part of the plan. For example, a medication to be used, lab tests to perform, self-monitoring that has occurred, education etc.; (xsd)activity:CarePlan.activity>*
[]< General notes about the care plan not covered elsewhere.; (xsd)note:Annotation>*🔗 Identifies an action that has occurred or is a planned action to occur as part of the plan. For example, a medication to be used, lab tests to perform, self-monitoring that has occurred, education etc.CarePlan.activity(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< Identifies the activity that was performed. For example, an activity could be patient education, exercise, or a medication administration. The reference to an "event" resource, such as Procedure or Encounter or Observation, represents the activity that was performed. The requested activity can be conveyed using the CarePlan.activity.plannedActivityReference (a reference to a “request” resource). Note that this should not duplicate the activity status (e.g. completed or in progress). The activity performed is independent of the outcome of the related goal(s). For example, if the goal is to achieve a target body weight of 150 lbs and an activity is defined to exercise, then the activity performed could be amount and intensity of exercise performed whereas the goal outcome is an observation for the actual body weight measured. Binding: care-plan-activity-performed (example, Identifies the results of the activity.); (xsd)performedActivity:Resource*>*
[]< Notes about the adherence/status/progress of the activity. This element should NOT be used to describe the activity to be performed - that occurs either within the resource pointed to by activity.detail.reference or in activity.detail.description.; (xsd)progress:Annotation>*
< The details of the proposed activity represented in a specific resource. Standard extension exists ([http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal](http://hl7.org/fhir/extensions/StructureDefinition-resource-pertainsToGoal.html)) that allows goals to be referenced from any of the referenced resources in CarePlan.activity.plannedActivityReference.
The goal should be visible when the resource referenced by CarePlan.activity.plannedActivityReference is viewed independently from the CarePlan. Requests that are pointed to by a CarePlan using this element should *not* point to this CarePlan using the "basedOn" element. i.e. Requests that are part of a CarePlan are not "based on" the CarePlan.; (xsd)plannedActivityReference:(<Appointment>
|<CommunicationRequest>
|<DeviceRequest>
|<ImmunizationRecommendation>
|<MedicationRequest>
|<NutritionOrder>
|<RequestOrchestration>
|<ServiceRequest>
|<SupplyRequest>
|<Task>
|<VisionPrescription>)>?🔗 The Care Team includes all the people and organizations who plan to participate in the coordination and delivery of care.CareTeam(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< Business identifiers assigned to this care team by the performer or other systems which remain constant as the resource is updated and propagates from server to server. This is a business identifier, not a resource identifier (see [discussion](resource.html#identifiers)). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.; (xsd)identifier:Identifier>*
< Indicates the current state of the care team. This element is labeled as a modifier because the status contains the code entered-in-error that marks the care team as not currently valid. Binding: care-team-status (required, Indicates the status of the care team.); (xsd)status:code>?
[]< Identifies what kind of team. This is to support differentiation between multiple co-existing teams, such as care plan team, episode of care team, longitudinal care team. There may be multiple axis of categorization and one team may serve multiple purposes. Binding: care-team-category (example, Indicates the type of care team.); (xsd)category:CodeableConcept>*
< A label for human use intended to distinguish like teams. E.g. the "red" vs. "green" trauma teams. The meaning/purpose of the team is conveyed in CareTeam.category. This element may also convey semantics of the team (e.g. "Red trauma team"), but its primary purpose is to distinguish between identical teams in a human-friendly way. ("Team 18735" isn't as friendly.).; (xsd)name:string>?
< Identifies the patient or group whose intended care is handled by the team. Use Group for care provision to all members of the group (e.g. group therapy). Use Patient for care provision to an individual patient.; (xsd)subject:(<Group>
|<Patient>)>?
< Indicates when the team did (or is intended to) come into effect and end.; (xsd)period:Period>?
[]< Identifies all people and organizations who are expected to be involved in the care team.; (xsd)participant:CareTeam.participant>*
[]< Describes why the care team exists. Binding: clinical-findings (example, Indicates the reason for the care team.); (xsd)reason:Condition*>*
[]< The organization responsible for the care team.; (xsd)managingOrganization:Organization*>*
[]< A central contact detail for the care team (that applies to all members). The ContactPoint.use code of home is not appropriate to use. These contacts are not the contact details of individual care team members.; (xsd)telecom:ContactPoint>*
[]< Comments made about the CareTeam.; (xsd)note:Annotation>*🔗 Identifies all people and organizations who are expected to be involved in the care team.CareTeam.participant(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Indicates specific responsibility of an individual within the care team, such as "Primary care physician", "Trained social worker counselor", "Caregiver", etc. Roles may sometimes be inferred by type of Practitioner. These are relationships that hold only within the context of the care team. General relationships should be handled as properties of the Patient resource directly. If a participant has multiple roles within the team, then there should be multiple participants. Binding: participant-role (example, Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc.); (xsd)role:CodeableConcept>?
< The specific person or organization who is participating/expected to participate in the care team. Patient only needs to be listed if they have a role other than "subject of care".
Member is optional because some participants may be known only by their role, particularly in draft plans.; (xsd)member:(<CareTeam>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>?
< The organization of the practitioner.; (xsd)onBehalfOf:Organization*>?
< When the member is generally available within this care team. This is populated while creating / managing the CareTeam to ensure there is coverage when servicing CarePlan activities from the Schedule.; (xsd)coverage:(<Period>
|<Timing>)>?🔗 A set of healthcare-related information that is assembled together into a single logical document that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. While a Composition defines the structure, it does not actually contain the content: rather the full content of a document is contained in a Bundle, of which the Composition is the first resource contained. While the focus of this specification is on patient-specific clinical statements, this resource can also apply to other healthcare-related statements such as study protocol designs, healthcare invoices and other activities that are not necessarily patient-specific or clinical.catalog(xsd)(doc)=
<#base:Composition>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< An Extension; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< An absolute URI that is used to identify this Composition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this Composition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the Composition is stored on different servers. Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.; (xsd)url:uri>?
[]< A version-independent identifier for the Composition. This identifier stays constant as the composition is changed over time. Similar to ClinicalDocument/setId in CDA. See discussion in resource definition for how these relate.; (xsd)identifier:Identifier>*
< An explicitly assigned identifer of a variation of the content in the Composition. While each resource, including the composition itself, has its own version identifier, this is a formal identifier for the logical version of the Composition as a whole. It would remain constant if the resources were moved to a new server, and all got new individual resource versions, for example.; (xsd)version:string>?
< The workflow/clinical status of this composition. The status is a marker for the clinical standing of the document. If a composition is marked as withdrawn, the compositions/documents in the series, or data from the composition or document series, should never be displayed to a user without being clearly marked as untrustworthy. The flag "entered-in-error" is why this element is labeled as a modifier of other elements.
Some reporting work flows require that the original narrative of a final document never be altered; instead, only new narrative can be added. The composition resource has no explicit status for explicitly noting whether this business rule is in effect. This would be handled by an extension if required. Binding: composition-status (required, The workflow/clinical status of the composition.); (xsd)status:code>
< The type of document - a Catalog. For Composition type, LOINC is ubiquitous and strongly endorsed by HL7. Most implementation guides will require a specific LOINC code, or use LOINC as an extensible binding. Binding: doc-typecodes (preferred, Type of a composition.) Catalog; (xsd)type:CodeableConcept>
< The content (narrative and data) associated with the section. Binding: catalogType (example, The type of catalog.); (xsd)category:CodeableConcept>
< Who or what the composition is about. The composition can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of livestock, or a set of patients that share a common exposure). For clinical documents, this is usually the patient.; (xsd)subject:Resource*>{0,0}
< Describes the clinical encounter or type of care this documentation is associated with.; (xsd)encounter:Encounter*>?
[]< The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate Composition instances. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.; (xsd)useContext:UsageContext>*
[]< Identifies who is responsible for the information in the composition, not necessarily who typed it in.; (xsd)author:(<Device>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>+
< A natural language name identifying the {{title}}. This name should be usable as an identifier for the module by machine processing applications such as code generation. The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.; (xsd)name:string>?
< Official human-readable label for the composition. For many compositions, the title is the same as the text or a display name of Composition.type (e.g. a "consultation" or "progress note"). Note that CDA does not make title mandatory, but there are no known cases where it is useful for title to be omitted, so it is mandatory here. Feedback on this requirement is welcome during the trial use period.; (xsd)title:string>
[]< For any additional notes. A comment, general note or annotation not coded elsewhere.; (xsd)note:Annotation>*
[]< A participant who has attested to the accuracy of the composition/document. Only list each attester once.; (xsd)attester:catalog.attester>*
< Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information. This is useful when documents are derived from a composition - provides guidance for how to get the latest version of the document. This is optional because this is sometimes not known by the authoring system, and can be inferred by context. However, it is important that this information be known when working with a derived document, so providing a custodian is encouraged.; (xsd)custodian:Organization*>?
[]< Relationships that this composition has with other compositions or documents that already exist. To reference (using relatesTo) a Bundle of type "document" or another Composition where you only have the identifier, use a resourceReference with an identifier.\
When a Composition is an alternate representation of another type of document e.g. CDA, the other document could be referenced in a DocumentReference resource.
Here is an example of using relatesTo to reference another Bundle of type "document" or Composition where you only have the identifier:
```
"relatesTo": [{
"type": "replaces",
"resourceReference": {
"identifier": {
"system": "...",
"value": "..."
}
}
}]
```; (xsd)relatesTo:RelatedArtifact>*
[]< The clinical service, such as a colonoscopy or an appendectomy, being documented. The event needs to be consistent with the type element, though can provide further information if desired.; (xsd)event:catalog.event>*
[]< The root of the sections that make up the composition.; (xsd)section:catalog.section>*
< The validity of the catalog.; (xsd)ValidityPeriod:Extension>
< When the Catalog was created. The Last Modified Date on the composition may be after the date of the document was attested without being changed. This means that the date on an amended document is the date of the amendment, not the date of original authorship.; (xsd)IssueDate:dateTime>🔗 A set of healthcare-related information that is assembled together into a single logical package that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. A Composition defines the structure and narrative content necessary for a document. However, a Composition alone does not constitute a document. Rather, the Composition must be the first entry in a Bundle where Bundle.type=document, and any other resources referenced from Composition must be included as subsequent entries in the Bundle (for example Patient, Practitioner, Encounter, etc.). While the focus of this specification is on patient-specific clinical statements, this resource can also apply to other healthcare-related statements such as study protocol designs, healthcare invoices and other activities that are not necessarily patient-specific or clinical.Catalog(xsd)(doc)=
<#base:Composition>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< An Extension; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< An absolute URI that is used to identify this Composition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this Composition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the Composition is stored on different servers. Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.; (xsd)url:uri>?
[]< A version-independent identifier for the Composition. This identifier stays constant as the composition is changed over time. Similar to ClinicalDocument/setId in CDA. See discussion in resource definition for how these relate.; (xsd)identifier:Identifier>*
< An explicitly assigned identifer of a variation of the content in the Composition. While each resource, including the composition itself, has its own version identifier, this is a formal identifier for the logical version of the Composition as a whole. It would remain constant if the resources were moved to a new server, and all got new individual resource versions, for example.; (xsd)version:string>?
< The workflow/clinical status of this composition. The status is a marker for the clinical standing of the document. If a composition is marked as withdrawn, the compositions/documents in the series, or data from the composition or document series, should never be displayed to a user without being clearly marked as untrustworthy. The flag "entered-in-error" is why this element is labeled as a modifier of other elements.
Some reporting work flows require that the original narrative of a final document never be altered; instead, only new narrative can be added. The composition resource has no explicit status for explicitly noting whether this business rule is in effect. This would be handled by an extension if required. Binding: composition-status (required, The workflow/clinical status of the composition.); (xsd)status:code>
< The type of document - a Catalog. For Composition type, LOINC is ubiquitous and strongly endorsed by HL7. Most implementation guides will require a specific LOINC code, or use LOINC as an extensible binding. Binding: doc-typecodes (preferred, Type of a composition.) Catalog; (xsd)type:CodeableConcept>
< The content (narrative and data) associated with the section. Binding: catalogType (example, The type of catalog.); (xsd)category:CodeableConcept>
< Who or what the composition is about. The composition can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of livestock, or a set of patients that share a common exposure). For clinical documents, this is usually the patient.; (xsd)subject:Resource*>{0,0}
< Describes the clinical encounter or type of care this documentation is associated with.; (xsd)encounter:Encounter*>?
< When the Catalog was created. The Last Modified Date on the composition may be after the date of the document was attested without being changed. This means that the date on an amended document is the date of the amendment, not the date of original authorship.; (xsd)date:dateTime>
[]< The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate Composition instances. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.; (xsd)useContext:UsageContext>*
[]< Identifies who is responsible for the information in the composition, not necessarily who typed it in.; (xsd)author:(<Device>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>+
< A natural language name identifying the {{title}}. This name should be usable as an identifier for the module by machine processing applications such as code generation. The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.; (xsd)name:string>?
< Official human-readable label for the composition. For many compositions, the title is the same as the text or a display name of Composition.type (e.g. a "consultation" or "progress note"). Note that CDA does not make title mandatory, but there are no known cases where it is useful for title to be omitted, so it is mandatory here. Feedback on this requirement is welcome during the trial use period.; (xsd)title:string>
[]< For any additional notes. A comment, general note or annotation not coded elsewhere.; (xsd)note:Annotation>*
[]< A participant who has attested to the accuracy of the composition/document. Only list each attester once.; (xsd)attester:Catalog.attester>*
< Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information. This is useful when documents are derived from a composition - provides guidance for how to get the latest version of the document. This is optional because this is sometimes not known by the authoring system, and can be inferred by context. However, it is important that this information be known when working with a derived document, so providing a custodian is encouraged.; (xsd)custodian:Organization*>?
[]< Relationships that this composition has with other compositions or documents that already exist. To reference (using relatesTo) a Bundle of type "document" or another Composition where you only have the identifier, use a resourceReference with an identifier.\
When a Composition is an alternate representation of another type of document e.g. CDA, the other document could be referenced in a DocumentReference resource.
Here is an example of using relatesTo to reference another Bundle of type "document" or Composition where you only have the identifier:
```
"relatesTo": [{
"type": "replaces",
"resourceReference": {
"identifier": {
"system": "...",
"value": "..."
}
}
}]
```; (xsd)relatesTo:RelatedArtifact>*
[]< The clinical service, such as a colonoscopy or an appendectomy, being documented. The event needs to be consistent with the type element, though can provide further information if desired.; (xsd)event:Catalog.event>*
[]< The root of the sections that make up the composition.; (xsd)section:Catalog.section>*
< The period in which the Composition is valid (for Order Catalog profiles), with optional start and end dates.; (xsd)ValidityPeriod>?🔗 A participant who has attested to the accuracy of the composition/document. Only list each attester once.catalog.attester(xsd)(doc)=
<#base:Composition.attester>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The type of attestation the authenticator offers. Binding: composition-attestation-mode (preferred, The way in which a person authenticated a composition.); (xsd)mode:CodeableConcept>
< When the composition was attested by the party.; (xsd)time:dateTime>?
< Who attested the composition in the specified way.; (xsd)party:(<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>?🔗 A participant who has attested to the accuracy of the composition/document. Only list each attester once.Catalog.attester(xsd)(doc)=
<#base:Composition.attester>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The type of attestation the authenticator offers. Binding: composition-attestation-mode (preferred, The way in which a person authenticated a composition.); (xsd)mode:CodeableConcept>
< When the composition was attested by the party.; (xsd)time:dateTime>?
< Who attested the composition in the specified way.; (xsd)party:(<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>?🔗 The clinical service, such as a colonoscopy or an appendectomy, being documented. The event needs to be consistent with the type element, though can provide further information if desired.catalog.event(xsd)(doc)=
<#base:Composition.event>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The period of time covered by the documentation. There is no assertion that the documentation is a complete representation for this period, only that it documents events during this time.; (xsd)period:Period>?
[]< Represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the typeCode, such as a "History and Physical Report" in which case the procedure being documented is necessarily a "History and Physical" act. The events may be included as a code or as a reference to an other resource. An event can further specialize the act inherent in the typeCode, such as where it is simply "Procedure Report" and the procedure was a "colonoscopy". If one or more events are included, they SHALL NOT conflict with the values inherent in the classCode, practiceSettingCode or typeCode, as such a conflict would create an ambiguous situation. This short list of codes is provided to be used as key words for certain types of queries. Binding: http://terminology.hl7.org/ValueSet/v3-ActCode (example, This list of codes represents the main clinical acts being documented.); (xsd)detail:Resource*>*🔗 The clinical service, such as a colonoscopy or an appendectomy, being documented. The event needs to be consistent with the type element, though can provide further information if desired.Catalog.event(xsd)(doc)=
<#base:Composition.event>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The period of time covered by the documentation. There is no assertion that the documentation is a complete representation for this period, only that it documents events during this time.; (xsd)period:Period>?
[]< Represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the typeCode, such as a "History and Physical Report" in which case the procedure being documented is necessarily a "History and Physical" act. The events may be included as a code or as a reference to an other resource. An event can further specialize the act inherent in the typeCode, such as where it is simply "Procedure Report" and the procedure was a "colonoscopy". If one or more events are included, they SHALL NOT conflict with the values inherent in the classCode, practiceSettingCode or typeCode, as such a conflict would create an ambiguous situation. This short list of codes is provided to be used as key words for certain types of queries. Binding: http://terminology.hl7.org/ValueSet/v3-ActCode (example, This list of codes represents the main clinical acts being documented.); (xsd)detail:Resource*>*🔗 The root of the sections that make up the composition.catalog.section(xsd)(doc)=
<#base:Composition.section>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents. The title identifies the section for a human reader. The title must be consistent with the narrative of the resource that is the target of the section.content reference. Generally, sections SHOULD have titles, but in some documents, it is unnecessary or inappropriate. Typically, this is where a section has subsections that have their own adequately distinguishing title, or documents that only have a single section. Most Implementation Guides will make section title to be a required element.; (xsd)title:string>?
< A code identifying the kind of content contained within the section. This must be consistent with the section title. The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document.
If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code. Binding: doc-section-codes (example, Classification of a section of a composition/document.); (xsd)code:CodeableConcept>?
[]< Identifies who is responsible for the information in this section, not necessarily who typed it in.; (xsd)author:(<Device>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>*
< The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources). Typically, sections in a doument are about the subject of the document, whether that is a patient, or group of patients, location, or device, or whatever. For some kind of documents, some sections actually contain data about related entities. Typical examples are a section in a newborn discharge summary concerning the mother, or family history documents, with a section about each family member, though there are many other examples.; (xsd)focus:Resource*>?
< A human-readable narrative that contains the attested content of the section, 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. Document profiles may define what content should be represented in the narrative to ensure clinical safety.; (xsd)text:Narrative>?
< Specifies the order applied to the items in the section entries. Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order. Binding: list-order (preferred, What order applies to the items in the entry.); (xsd)orderedBy:CodeableConcept>?
[]< A reference to the actual resource from which the narrative in the section is derived. If there are no entries in the list, an emptyReason SHOULD be provided.; (xsd)entry:Resource*>*
< If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason. The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases. Binding: list-empty-reason (preferred, If a section is empty, why it is empty.); (xsd)emptyReason:CodeableConcept>?
[]< A nested sub-section within this section. Nested sections are primarily used to help human readers navigate to particular portions of the document.; (xsd)section:Composition.section>*🔗 The root of the sections that make up the composition.Catalog.section(xsd)(doc)=
<#base:Composition.section>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents. The title identifies the section for a human reader. The title must be consistent with the narrative of the resource that is the target of the section.content reference. Generally, sections SHOULD have titles, but in some documents, it is unnecessary or inappropriate. Typically, this is where a section has subsections that have their own adequately distinguishing title, or documents that only have a single section. Most Implementation Guides will make section title to be a required element.; (xsd)title:string>?
< A code identifying the kind of content contained within the section. This must be consistent with the section title. The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document.
If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code. Binding: doc-section-codes (example, Classification of a section of a composition/document.); (xsd)code:CodeableConcept>?
[]< Identifies who is responsible for the information in this section, not necessarily who typed it in.; (xsd)author:(<Device>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>*
< The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources). Typically, sections in a doument are about the subject of the document, whether that is a patient, or group of patients, location, or device, or whatever. For some kind of documents, some sections actually contain data about related entities. Typical examples are a section in a newborn discharge summary concerning the mother, or family history documents, with a section about each family member, though there are many other examples.; (xsd)focus:Resource*>?
< A human-readable narrative that contains the attested content of the section, 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. Document profiles may define what content should be represented in the narrative to ensure clinical safety.; (xsd)text:Narrative>?
< Specifies the order applied to the items in the section entries. Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order. Binding: list-order (preferred, What order applies to the items in the entry.); (xsd)orderedBy:CodeableConcept>?
[]< A reference to the actual resource from which the narrative in the section is derived. If there are no entries in the list, an emptyReason SHOULD be provided.; (xsd)entry:Resource*>*
< If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason. The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases. Binding: list-empty-reason (preferred, If a section is empty, why it is empty.); (xsd)emptyReason:CodeableConcept>?
[]< A nested sub-section within this section. Nested sections are primarily used to help human readers navigate to particular portions of the document.; (xsd)section:Composition.section>*🔗 A set of healthcare-related information that is assembled together into a single logical package that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. A Composition defines the structure and narrative content necessary for a document. However, a Composition alone does not constitute a document. Rather, the Composition must be the first entry in a Bundle where Bundle.type=document, and any other resources referenced from Composition must be included as subsequent entries in the Bundle (for example Patient, Practitioner, Encounter, etc.). While the focus of this specification is on patient-specific clinical statements, this resource can also apply to other healthcare-related statements such as study protocol designs, healthcare invoices and other activities that are not necessarily patient-specific or clinical.CatalogHeader(xsd)(doc)=
<#base:Composition>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< An Extension; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< An absolute URI that is used to identify this Composition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this Composition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the Composition is stored on different servers. Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.; (xsd)url:uri>?
[]< A version-independent identifier for the Composition. This identifier stays constant as the composition is changed over time. Similar to ClinicalDocument/setId in CDA. See discussion in resource definition for how these relate.; (xsd)identifier:Identifier>*
< An explicitly assigned identifer of a variation of the content in the Composition. While each resource, including the composition itself, has its own version identifier, this is a formal identifier for the logical version of the Composition as a whole. It would remain constant if the resources were moved to a new server, and all got new individual resource versions, for example.; (xsd)version:string>?
< The workflow/clinical status of this composition. The status is a marker for the clinical standing of the document. If a composition is marked as withdrawn, the compositions/documents in the series, or data from the composition or document series, should never be displayed to a user without being clearly marked as untrustworthy. The flag "entered-in-error" is why this element is labeled as a modifier of other elements.
Some reporting work flows require that the original narrative of a final document never be altered; instead, only new narrative can be added. The composition resource has no explicit status for explicitly noting whether this business rule is in effect. This would be handled by an extension if required. Binding: composition-status (required, The workflow/clinical status of the composition.); (xsd)status:code>
< Specifies the particular kind of composition (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the composition. For Composition type, LOINC is ubiquitous and strongly endorsed by HL7. Most implementation guides will require a specific LOINC code, or use LOINC as an extensible binding. Binding: doc-typecodes (preferred, Type of a composition.); (xsd)type:CatalogHeader.type>
[]< A categorization for the type of the composition - helps for indexing and searching. This may be implied by or derived from the code specified in the Composition Type. Binding: catalogType (example, Category of catalog content); (xsd)category:CodeableConcept>*
[]< The catalog may be set up to be used in the context of a particular plan or set of financial, organizational or legal dispositions For example the catalog may provide the details of reimbursement of its items within the context of an insurance plan handled by a payer; (xsd)subject:Resource*>*
< Describes the clinical encounter or type of care this documentation is associated with.; (xsd)encounter:Encounter*>{0,0}
< The composition editing time, when the composition was last logically changed by the author. The Last Modified Date on the composition may be after the date of the document was attested without being changed. This means that the date on an amended document is the date of the amendment, not the date of original authorship.; (xsd)date:dateTime>
[]< The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate Composition instances. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.; (xsd)useContext:UsageContext>*
[]< An organization authoring and owning the content of the catalog In general there is a single author for a catalog. However there may be use cases where multiple authors contribute to various parts of a catalog, each author owning one part and being responsible for its content.; (xsd)author:Organization*>+
< A natural language name identifying the {{title}}. This name should be usable as an identifier for the module by machine processing applications such as code generation. The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.; (xsd)name:string>?
< Official human-readable label for the composition. For many compositions, the title is the same as the text or a display name of Composition.type (e.g. a "consultation" or "progress note"). Note that CDA does not make title mandatory, but there are no known cases where it is useful for title to be omitted, so it is mandatory here. Feedback on this requirement is welcome during the trial use period.; (xsd)title:CatalogHeader.title>
[]< For any additional notes. A comment, general note or annotation not coded elsewhere.; (xsd)note:Annotation>*
< A participant who has attested to the accuracy of the composition/document. Only list each attester once.; (xsd)attester:CatalogHeader.attester>?
< Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information. This is useful when documents are derived from a composition - provides guidance for how to get the latest version of the document. This is optional because this is sometimes not known by the authoring system, and can be inferred by context. However, it is important that this information be known when working with a derived document, so providing a custodian is encouraged.; (xsd)custodian:Organization*>
[]< Relationships that this composition has with other compositions or documents that already exist. To reference (using relatesTo) a Bundle of type "document" or another Composition where you only have the identifier, use a resourceReference with an identifier.\
When a Composition is an alternate representation of another type of document e.g. CDA, the other document could be referenced in a DocumentReference resource.
Here is an example of using relatesTo to reference another Bundle of type "document" or Composition where you only have the identifier:
```
"relatesTo": [{
"type": "replaces",
"resourceReference": {
"identifier": {
"system": "...",
"value": "..."
}
}
}]
```; (xsd)relatesTo:RelatedArtifact>*
< The clinical service, such as a colonoscopy or an appendectomy, being documented. The event needs to be consistent with the type element, though can provide further information if desired.; (xsd)event:CatalogHeader.event>{0,0}
< The root of the sections that make up the composition.; (xsd)section:CatalogHeader.section>{0,0}
< The period in which the Composition is valid (for Order Catalog profiles), with optional start and end dates.; (xsd)ValidityPeriod>?🔗 A participant who has attested to the accuracy of the composition/document. Only list each attester once.CatalogHeader.attester(xsd)(doc)=
<#base:Composition.attester>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The type of attestation the authenticator offers. Binding: composition-attestation-mode (preferred, The way in which a person authenticated a composition.); (xsd)mode:CodeableConcept>
< When the composition was attested by the party.; (xsd)time:dateTime>
< Who attested the composition in the specified way.; (xsd)party:(<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>?🔗 The clinical service, such as a colonoscopy or an appendectomy, being documented. The event needs to be consistent with the type element, though can provide further information if desired.CatalogHeader.event(xsd)(doc)=
<#base:Composition.event>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The period of time covered by the documentation. There is no assertion that the documentation is a complete representation for this period, only that it documents events during this time.; (xsd)period:Period>?
[]< Represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the typeCode, such as a "History and Physical Report" in which case the procedure being documented is necessarily a "History and Physical" act. The events may be included as a code or as a reference to an other resource. An event can further specialize the act inherent in the typeCode, such as where it is simply "Procedure Report" and the procedure was a "colonoscopy". If one or more events are included, they SHALL NOT conflict with the values inherent in the classCode, practiceSettingCode or typeCode, as such a conflict would create an ambiguous situation. This short list of codes is provided to be used as key words for certain types of queries. Binding: http://terminology.hl7.org/ValueSet/v3-ActCode (example, This list of codes represents the main clinical acts being documented.); (xsd)detail:Resource*>*🔗 The root of the sections that make up the composition.CatalogHeader.section(xsd)(doc)=
<#base:Composition.section>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents. The title identifies the section for a human reader. The title must be consistent with the narrative of the resource that is the target of the section.content reference. Generally, sections SHOULD have titles, but in some documents, it is unnecessary or inappropriate. Typically, this is where a section has subsections that have their own adequately distinguishing title, or documents that only have a single section. Most Implementation Guides will make section title to be a required element.; (xsd)title:string>?
< A code identifying the kind of content contained within the section. This must be consistent with the section title. The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document.
If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code. Binding: doc-section-codes (example, Classification of a section of a composition/document.); (xsd)code:CodeableConcept>?
[]< Identifies who is responsible for the information in this section, not necessarily who typed it in.; (xsd)author:(<Device>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>*
< The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources). Typically, sections in a doument are about the subject of the document, whether that is a patient, or group of patients, location, or device, or whatever. For some kind of documents, some sections actually contain data about related entities. Typical examples are a section in a newborn discharge summary concerning the mother, or family history documents, with a section about each family member, though there are many other examples.; (xsd)focus:Resource*>?
< A human-readable narrative that contains the attested content of the section, 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. Document profiles may define what content should be represented in the narrative to ensure clinical safety.; (xsd)text:Narrative>?
< Specifies the order applied to the items in the section entries. Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order. Binding: list-order (preferred, What order applies to the items in the entry.); (xsd)orderedBy:CodeableConcept>?
[]< A reference to the actual resource from which the narrative in the section is derived. If there are no entries in the list, an emptyReason SHOULD be provided.; (xsd)entry:Resource*>*
< If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason. The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases. Binding: list-empty-reason (preferred, If a section is empty, why it is empty.); (xsd)emptyReason:CodeableConcept>?
[]< A nested sub-section within this section. Nested sections are primarily used to help human readers navigate to particular portions of the document.; (xsd)section:Composition.section>*🔗 Official human-readable label for the composition. For many compositions, the title is the same as the text or a display name of Composition.type (e.g. a "consultation" or "progress note"). Note that CDA does not make title mandatory, but there are no known cases where it is useful for title to be omitted, so it is mandatory here. Feedback on this requirement is welcome during the trial use period.CatalogHeader.title(xsd)(doc)=
<#base:string>
< unique id for the element within a resource (for internal references); (xsd)id:string>?
[]< An Extension; (xsd)extension:Extension>*
< The actual value; (xsd)value:string>?
[]< Language translation from base language of resource to another language.; (xsd)OtherTitle:Extension>*🔗 Specifies the particular kind of composition (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the composition. For Composition type, LOINC is ubiquitous and strongly endorsed by HL7. Most implementation guides will require a specific LOINC code, or use LOINC as an extensible binding. Binding: doc-typecodes (preferred, Type of a composition.)CatalogHeader.type(xsd)(doc)=
<#base:CodeableConcept>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< 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.; (xsd)coding:Coding>*
< 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. Catalog; (xsd)text:string>🔗 Defines the characteristics of a message that can be shared between systems, including the type of event that initiates the message, the content to be transmitted and what response(s), if any, are permitted. This would be a MIF-level artifact.CatalogMessageDefinition(xsd)(doc)=
<#base:MessageDefinition>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< The business identifier that is used to reference the MessageDefinition and *is* expected to be consistent from server to server. Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.
The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](http://hl7.org/fhir/R5/resource.html#versions).
In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](http://hl7.org/fhir/R5/resource.html#meta) element to indicate where the current master source of the resource can be found.; (xsd)url:uri>?
[]< A formal identifier that is used to identify this message definition when it is represented in other formats, or referenced in a specification, model, design or an instance. Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this message definition outside of FHIR, where it is not possible to use the logical URI.; (xsd)identifier:Identifier>*
< The identifier that is used to identify this version of the message definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the message definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. There may be different message definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the message definition with the format [url]|[version]. The version SHOULD NOT contain a '#' - see [Business Version](http://hl7.org/fhir/R5/resource.html#bv-format).; (xsd)version:string>?
< Indicates the mechanism used to compare versions to determine which is more current. If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined. Binding: version-algorithm (extensible, ); (xsd)versionAlgorithm:(<Coding>
|<string>)>?
< A natural language name identifying the message definition. This name should be usable as an identifier for the module by machine processing applications such as code generation. The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.; (xsd)name:string>?
< A short, descriptive, user-friendly title for the message definition. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.; (xsd)title:string>?
[]< A MessageDefinition that is superseded by this definition.; (xsd)replaces:MessageDefinition*>*
< The status of this message definition. Enables tracking the life-cycle of the content. Allows filtering of message definitions that are appropriate for use versus not.
See guidance around (not) making local changes to elements [here](http://hl7.org/fhir/R5/canonicalresource.html#localization). Binding: publication-status (required, The lifecycle status of an artifact.); (xsd)status:code>
< A Boolean value to indicate that this message definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. Allows filtering of message definitions that are appropriate for use versus not.; (xsd)experimental:boolean>?
< The date (and optionally time) when the message definition was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the message definition changes. The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the message definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
See guidance around (not) making local changes to elements [here](http://hl7.org/fhir/R5/canonicalresource.html#localization).; (xsd)date:dateTime>
< The name of the organization or individual responsible for the release and ongoing maintenance of the message definition. Usually an organization but may be an individual. The publisher (or steward) of the message definition is the organization or individual primarily responsible for the maintenance and upkeep of the message definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the message definition. This item SHOULD be populated unless the information is available from context.; (xsd)publisher:string>?
[]< Contact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc.
See guidance around (not) making local changes to elements [here](http://hl7.org/fhir/R5/canonicalresource.html#localization).; (xsd)contact:ContactDetail>*
< A free text natural language description of the message definition from a consumer's perspective. This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the message definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the message definition is presumed to be the predominant language in the place the message definition was created).; (xsd)description:markdown>?
[]< The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate message definition instances. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.; (xsd)useContext:UsageContext>*
[]< A legal or geographic region in which the message definition is intended to be used. It may be possible for the message definition to be used in jurisdictions other than those for which it was originally designed or intended.
DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.) Binding: jurisdiction (extensible, Countries and regions within which this artifact is targeted for use.); (xsd)jurisdiction:CodeableConcept>*
< Explanation of why this message definition is needed and why it has been designed as it has. This element does not describe the usage of the message definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this message definition.; (xsd)purpose:markdown>?
< A copyright statement relating to the message definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the message definition.; (xsd)copyright:markdown>?
< A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved'). The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.; (xsd)copyrightLabel:string>?
< The MessageDefinition that is the basis for the contents of this resource.; (xsd)base:MessageDefinition*>?
[]< Identifies a protocol or workflow that this MessageDefinition represents a step in. It should be possible to use MessageDefinition to describe a message to be used by certain steps in a particular protocol as part of a PlanDefinition or ActivityDefinition.; (xsd)parent:(<ActivityDefinition>
|<PlanDefinition>)>*
< Event code for messages conveying order-catalog content Binding: catalog-message-events-vs (extensible, message events for messages conveying order-catalog content); (xsd)event:Coding>
< The impact of the content of the message. Binding: message-significance-category (required, The impact of the content of a message.) consequence; (xsd)category:code>?
[]< Identifies the resource (or resources) that are being addressed by the event. For example, the Encounter for an admit message or two Account records for a merge.; (xsd)focus:CatalogMessageDefinition.focus>*
< Declare at a message definition level whether a response is required or only upon error or success, or never. This enables the capability currently available through MSH-16 (Application Level acknowledgement) in HL7 Version 2 to declare at a message instance level whether a response is required or only upon error or success, or never. Binding: messageheader-response-request (required, This enables the capability currently available through MSH-16 (Application Level acknowledgement) in HL7 Version 2 to declare at a message definition level whether a response is required or only upon error or success, or never.); (xsd)responseRequired:code>
[]< Indicates what types of messages may be sent as an application-level response to this message. This indicates an application level response to "close" a transaction implicit in a particular request message. To define a complete workflow scenario, look to the [[PlanDefinition]] resource which allows the definition of complex orchestrations, conditionality, etc.; (xsd)allowedResponse:CatalogMessageDefinition.allowedResponse>*
< Graph is Canonical reference to a GraphDefinition. If a URL is provided, it is the canonical reference to a GraphDefinition that it controls what additional resources are to be added to the Bundle when building the message. The GraphDefinition can also specify profiles that apply to the various resources.; (xsd)graph:GraphDefinition*>?🔗 Indicates what types of messages may be sent as an application-level response to this message. This indicates an application level response to "close" a transaction implicit in a particular request message. To define a complete workflow scenario, look to the [[PlanDefinition]] resource which allows the definition of complex orchestrations, conditionality, etc.CatalogMessageDefinition.allowedResponse(xsd)(doc)=
<#base:MessageDefinition.allowedResponse>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A reference to the message definition that must be adhered to by this supported response.; (xsd)message:MessageDefinition*>
< Provides a description of the circumstances in which this response should be used (as opposed to one of the alternative responses).; (xsd)situation:markdown>?🔗 Identifies the resource (or resources) that are being addressed by the event. For example, the Encounter for an admit message or two Account records for a merge.CatalogMessageDefinition.focus(xsd)(doc)=
<#base:MessageDefinition.focus>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The kind of resource that must be the focus for this message. Multiple focuses addressing different resources may occasionally occur. E.g. to link or unlink a resource from a particular account or encounter, etc. Binding: resource-types (required, One of the resource types defined as part of this version of FHIR.); (xsd)code>
< A profile that reflects constraints for the focal resource (and potentially for related resources). This should be present for most message definitions. However, if the message focus is only a single resource and there is no need to include referenced resources or otherwise enforce the presence of particular elements, it can be omitted.; (xsd)profile:StructureDefinition*>?
< Identifies the minimum number of resources of this type that must be pointed to by a message in order for it to be valid against this MessageDefinition.; (xsd)min:unsignedInt>
< Identifies the maximum number of resources of this type that must be pointed to by a message in order for it to be valid against this MessageDefinition.; (xsd)max:string>?🔗 This extension to PlanDefinition, MedicationKnowledge and DeviceDefinition conveys the reference to a catalog containing the extended resourceCatalogReference(xsd)(doc)=
<#base:Extension>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
< An Extension; (xsd)extension:Extension>{0,0}
< 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. http://hl7.org/fhir/uv/order-catalog/StructureDefinition/CatalogReference; (xsd)url:string>
< Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R5/extensibility.html) for a list).; (xsd)value:CatalogHeader*>?🔗 A guidance response is the formal response to a guidance request, including any output parameters returned by the evaluation, as well as the description of any proposed actions to be taken.cdshooksguidanceresponse(xsd)(doc)=
<#base:GuidanceResponse>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< An Extension; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< The identifier of the request associated with this response. If an identifier was given as part of the request, it will be reproduced here to enable the requester to more easily identify the response in a multi-request scenario.; (xsd)requestIdentifier:Identifier>
< Allows a service to provide unique, business identifiers for the response.; (xsd)identifier:Identifier>
< An identifier, CodeableConcept or canonical reference to the guidance that was requested. Binding: guidance-module-code (example, ); (xsd)module:uri>
< The status of the response. If the evaluation is completed successfully, the status will indicate success. However, in order to complete the evaluation, the engine may require more information. In this case, the status will be data-required, and the response will contain a description of the additional required information. If the evaluation completed successfully, but the engine determines that a potentially more accurate response could be provided if more data was available, the status will be data-requested, and the response will contain a description of the additional requested information. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. Binding: guidance-response-status (required, The status of a guidance response.); (xsd)status:code>
< The patient for which the request was processed.; (xsd)subject:(<Group>
|<Patient>)>?
< The encounter during which this response was created or to which the creation of this record is tightly associated. This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official copmletion of an encounter but still be tied to the context of the encounter.; (xsd)encounter:Encounter*>?
< Indicates when the guidance response was processed.; (xsd)occurrenceDateTime:dateTime>?
< Provides a reference to the device that performed the guidance.; (xsd)performer:Device*>?
[]< Describes the reason for the guidance response in coded or textual form, or Indicates the reason the request was initiated. This is typically provided as a parameter to the evaluation and echoed by the service, although for some use cases, such as subscription- or event-based scenarios, it may provide an indication of the cause for the response. Although this reference can be used to point to any resource, it is typically expected to refer to subject-specific data appropriate to the subject of the guidance. For example, patient-based decision support would be expected to reference patient-level data. In addition, implementations should provide as much detail as possible by using the [http://hl7.org/fhir/StructureDefinition/targetElement](http://hl7.org/fhir/extensions/StructureDefinition-targetElement.html) and [http://hl7.org/fhir/StructureDefinition/targetPath](http://hl7.org/fhir/extensions/StructureDefinition-targetPath.html) extensions to indicate the specific elements relevant to providing the reason for the guidance.; (xsd)reason:Resource*>*
[]< Provides a mechanism to communicate additional information about the response.; (xsd)note:Annotation>*
< Messages resulting from the evaluation of the artifact or artifacts. As part of evaluating the request, the engine may produce informational or warning messages. These messages will be provided by this element.; (xsd)evaluationMessage:OperationOutcome*>?
< The output parameters of the evaluation, if any. Many modules will result in the return of specific resources such as procedure or communication requests that are returned as part of the operation result. However, modules may define specific outputs that would be returned as the result of the evaluation, and these would be returned in this element.; (xsd)outputParameters:Parameters*>?
[]< The actions, if any, produced by the evaluation of the artifact.; (xsd)result:(<Appointment>
|<AppointmentResponse>
|<CarePlan>
|<Claim>
|<CommunicationRequest>
|<Contract>
|<CoverageEligibilityRequest>
|<DeviceRequest>
|<EnrollmentRequest>
|<ImmunizationRecommendation>
|<MedicationRequest>
|<NutritionOrder>
|<RequestOrchestration>
|<ServiceRequest>
|<SupplyRequest>
|<Task>
|<VisionPrescription>)>*
[]< If the evaluation could not be completed due to lack of information, or additional information would potentially result in a more accurate response, this element will a description of the data required in order to proceed with the evaluation. A subsequent request to the service should include this data.; (xsd)dataRequirement:DataRequirement>*
< Defines the service endpoint for the behavior implemented by the GuidanceResponse.; (xsd)cdsHooksEndpoint:Extension>
< An identifier, CodeableConcept or canonical reference to the guidance that was requested. Binding: guidance-module-code (example, ); (xsd)moduleUri:uri>🔗 A set of related requests that can be used to capture intended activities that have inter-dependencies such as "give this medication after that one".cdshooksrequestorchestration(xsd)(doc)=
<#base:RequestOrchestration>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< Allows a service to provide a unique, business identifier for the request.; (xsd)identifier:Identifier>
[]< A canonical URL referencing a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.; (xsd)instantiatesCanonical:Resource*>*
< A URL referencing an externally defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.; (xsd)instantiatesUri:uri>
[]< A plan, proposal or order that is fulfilled in whole or in part by this request.; (xsd)basedOn:Resource*>*
[]< Completed or terminated request(s) whose function is taken by this new request. The replacement could be because the initial request was immediately rejected (due to an issue) or because the previous request was completed, but the need for the action described by the request remains ongoing.; (xsd)replaces:Resource*>*
< A shared identifier common to multiple independent Request instances that were activated/authorized more or less simultaneously by a single author. The presence of the same identifier on each request ties those requests together and may have business ramifications in terms of reporting of results, billing, etc. E.g. a requisition number shared by a set of lab tests ordered together, or a prescription number shared by all meds ordered at one time. Requests are linked either by a "basedOn" relationship (i.e. one request is fulfilling another) or by having a common requisition. Requests that are part of the same requisition are generally treated independently from the perspective of changing their state or maintaining them after initial creation.; (xsd)groupIdentifier:Identifier>?
< The current state of the request. For request orchestrations, the status reflects the status of all the requests in the orchestration. Binding: request-status (required, Codes identifying the lifecycle stage of a request.); (xsd)status:code>
< Indicates the level of authority/intentionality associated with the request and where the request fits into the workflow chain. Binding: request-intent (required, Codes indicating the degree of authority/intentionality associated with a request.); (xsd)intent:code>
< Indicates how quickly the request should be addressed with respect to other requests. Binding: request-priority (required, Identifies the level of importance to be assigned to actioning the request.); (xsd)priority:code>?
< A code that identifies what the overall request orchestration is. This element can be used to provide a code that captures the meaning of the request orchestration as a whole, as opposed to the code of the action element, which captures the meaning of the individual actions within the request orchestration. Binding: action-code (example, ); (xsd)code:CodeableConcept>?
< The subject for which the request orchestration was created.; (xsd)subject:(<CareTeam>
|<Device>
|<Group>
|<HealthcareService>
|<Location>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>?
< Describes the context of the request orchestration, if any.; (xsd)encounter:Encounter*>?
< Indicates when the request orchestration was created.; (xsd)authoredOn:dateTime>?
< Provides a reference to the author of the request orchestration.; (xsd)author:(<Device>
|<Practitioner>
|<PractitionerRole>)>?
[]< Describes the reason for the request orchestration in coded or textual form. Binding: action-reason-code (example, ); (xsd)reason:(<Condition>
|<DiagnosticReport>
|<DocumentReference>
|<Observation>)>*
[]< Goals that are intended to be achieved by following the requests in this RequestOrchestration.; (xsd)goal:Goal*>*
[]< Provides a mechanism to communicate additional information about the response.; (xsd)note:Annotation>*
[]< The actions, if any, produced by the evaluation of the artifact.; (xsd)action:cdshooksrequestorchestration.action>*🔗 The actions, if any, produced by the evaluation of the artifact.cdshooksrequestorchestration.action(xsd)(doc)=
<#base:RequestOrchestration.action>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The linkId of the action from the PlanDefinition that corresponds to this action in the RequestOrchestration resource.; (xsd)linkId:string>?
< A user-visible prefix for the action. For example a section or item numbering such as 1. or A.; (xsd)prefix:string>?
< The title of the action displayed to a user.; (xsd)title:string>?
< A short description of the action used to provide a summary to display to the user.; (xsd)description:markdown>?
< A text equivalent of the action to be performed. This provides a human-interpretable description of the action when the definition is consumed by a system that might not be capable of interpreting it dynamically.; (xsd)textEquivalent:markdown>?
< Indicates how quickly the action should be addressed with respect to other actions. Binding: request-priority (required, Identifies the level of importance to be assigned to actioning the request.); (xsd)priority:code>?
[]< A code that provides meaning for the action or action group. For example, a section may have a LOINC code for a section of a documentation template. Binding: action-code (example, ); (xsd)code:CodeableConcept>*
[]< Didactic or other informational resources associated with the action that can be provided to the CDS recipient. Information resources can include inline text commentary and links to web resources.; (xsd)documentation:RelatedArtifact>*
[]< Goals that are intended to be achieved by following the requests in this action.; (xsd)goal:Goal*>*
[]< An expression that describes applicability criteria, or start/stop conditions for the action. When multiple conditions of the same kind are present, the effects are combined using AND semantics, so the overall condition is true only if all of the conditions are true.; (xsd)condition:cdshooksrequestorchestration.action.condition>*
[]< Defines input data requirements for the action.; (xsd)input:cdshooksrequestorchestration.action.input>*
[]< Defines the outputs of the action, if any.; (xsd)output:cdshooksrequestorchestration.action.output>*
[]< A relationship to another action such as "before" or "30-60 minutes after start of".; (xsd)relatedAction:cdshooksrequestorchestration.action.relatedAction>*
< An optional value describing when the action should be performed. The intent of the timing element is to provide timing for when the action should be performed. The timing may be absolute (specified as a dateTime or Period) or relative (specified as an Age, Duration, or Range), or it may be a more complex, potentially repeating timing specified using Timing.; (xsd)timing:(<Age>
|<dateTime>
|<Duration>
|<Period>
|<Range>
|<Timing>)>?
< Identifies the facility where the action will occur; e.g. home, hospital, specific clinic, etc. May reference a specific clinical location or may just identify a type of location.; (xsd)location:Location*>?
[]< The participant that should perform or be responsible for this action. Because request orchestrations represent potential options for performing activities, some specific participants may still be unknown, so this element allows for both definitional participants (in the same way they are specified in ActivityDefinition and PlanDefinition resources) as well as identifying specific participants when they are known.; (xsd)participant:cdshooksrequestorchestration.action.participant>*
< The type of action to perform (create, update, remove). Binding: action-type (extensible, The type of action to be performed.); (xsd)type:CodeableConcept>?
< Defines the grouping behavior for the action and its children. Binding: action-grouping-behavior (required, Defines organization behavior of a group.); (xsd)groupingBehavior:code>?
< Defines the selection behavior for the action and its children. Binding: action-selection-behavior (required, Defines selection behavior of a group.); (xsd)selectionBehavior:code>?
< Defines expectations around whether an action is required. Binding: action-required-behavior (required, Defines expectations around whether an action or action group is required.); (xsd)requiredBehavior:code>?
< Defines whether the action should usually be preselected. Binding: action-precheck-behavior (required, Defines selection frequency behavior for an action or group.); (xsd)precheckBehavior:code>?
< Defines whether the action can be selected multiple times. Binding: action-cardinality-behavior (required, Defines behavior for an action or a group for how many times that item may be repeated.); (xsd)cardinalityBehavior:code>?
< The resource that is the target of the action (e.g. CommunicationRequest). The target resource SHALL be a [Request](request.html) resource with a Request.intent set to "option".; (xsd)resource:Resource*>?
< A reference to an ActivityDefinition that describes the action to be taken in detail, a PlanDefinition that describes a series of actions to be taken, a Questionnaire that should be filled out, a SpecimenDefinition describing a specimen to be collected, or an ObservationDefinition that specifies what observation should be captured. Note that the definition is optional, and if no definition is specified, a dynamicValue with a root ($this) path can be used to define the entire resource dynamically.; (xsd)definition:(<ActivityDefinition>
|<ObservationDefinition>
|<PlanDefinition>
|<Questionnaire>
|<SpecimenDefinition>
|<uri>)>?
< A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input. Note that when a referenced ActivityDefinition also defines a transform, the transform specified here generally takes precedence. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.; (xsd)transform:StructureMap*>?
[]< Customizations that should be applied to the statically defined resource. For example, if the dosage of a medication must be computed based on the patient's weight, a customization would be used to specify an expression that calculated the weight, and the path on the resource that would contain the result. Dynamic values are applied in the order in which they are defined in the RequestOrchestration resource. Note that when dynamic values are also specified by a referenced ActivityDefinition, the dynamicValues from the ActivityDefinition are applied first, followed by the dynamicValues specified here. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.; (xsd)dynamicValue:cdshooksrequestorchestration.action.dynamicValue>*
[]< Sub actions.; (xsd)action:RequestOrchestration.action>*🔗 An expression that describes applicability criteria, or start/stop conditions for the action. When multiple conditions of the same kind are present, the effects are combined using AND semantics, so the overall condition is true only if all of the conditions are true.cdshooksrequestorchestration.action.condition(xsd)(doc)=
<#base:RequestOrchestration.action.condition>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The kind of condition. Applicability criteria are used to determine immediate applicability when a plan definition is applied to a given context. Start and stop criteria are carried through application and used to describe enter/exit criteria for an action. Binding: action-condition-kind (required, The kind of condition for the action.); (xsd)kind:code>
< An expression that returns true or false, indicating whether or not the condition is satisfied. The expression may be inlined, or may be a reference to a named expression within a logic library referenced by the library element.; (xsd)expression:Expression>?🔗 Customizations that should be applied to the statically defined resource. For example, if the dosage of a medication must be computed based on the patient's weight, a customization would be used to specify an expression that calculated the weight, and the path on the resource that would contain the result. Dynamic values are applied in the order in which they are defined in the RequestOrchestration resource. Note that when dynamic values are also specified by a referenced ActivityDefinition, the dynamicValues from the ActivityDefinition are applied first, followed by the dynamicValues specified here. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.cdshooksrequestorchestration.action.dynamicValue(xsd)(doc)=
<#base:RequestOrchestration.action.dynamicValue>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The path to the element to be customized. This is the path on the resource that will hold the result of the calculation defined by the expression. The specified path SHALL be a FHIRPath resolvable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. 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). To specify the path to the current action being realized, the %action environment variable is available in this path. For example, to specify the description element of the target action, the path would be %action.description. The path attribute contains a [Simple FHIRPath Subset](fhirpath.html#simple) that allows path traversal, but not calculation.; (xsd)path:string>?
< An expression specifying the value of the customized element. The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.; (xsd)expression:Expression>?🔗 Defines input data requirements for the action.cdshooksrequestorchestration.action.input(xsd)(doc)=
<#base:RequestOrchestration.action.input>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A human-readable label for the data requirement used to label data flows in BPMN or similar diagrams. Also provides a human readable label when rendering the data requirement that conveys its purpose to human readers.; (xsd)title:string>?
< Defines the data that is to be provided as input to the action.; (xsd)requirement:DataRequirement>?
< Points to an existing input or output element that provides data to this input. The relatedData element allows indicating that an input to a parent action is an input to specific child actions. It also allows the output of one action to be identified as the input to a different action; (xsd)relatedData:id>?🔗 Defines the outputs of the action, if any.cdshooksrequestorchestration.action.output(xsd)(doc)=
<#base:RequestOrchestration.action.output>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A human-readable label for the data requirement used to label data flows in BPMN or similar diagrams. Also provides a human readable label when rendering the data requirement that conveys its purpose to human readers.; (xsd)title:string>?
< Defines the data that results as output from the action.; (xsd)requirement:DataRequirement>?
< Points to an existing input or output element that is results as output from the action. The relatedData element allows indicating that the output of child action is also the output of a parent action. It also allows the input of one action to be identified as the output of a different action; (xsd)relatedData:string>?🔗 The participant that should perform or be responsible for this action. Because request orchestrations represent potential options for performing activities, some specific participants may still be unknown, so this element allows for both definitional participants (in the same way they are specified in ActivityDefinition and PlanDefinition resources) as well as identifying specific participants when they are known.cdshooksrequestorchestration.action.participant(xsd)(doc)=
<#base:RequestOrchestration.action.participant>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The type of participant in the action. Binding: action-participant-type (required, The type of participant in the activity.); (xsd)type:code>?
< The type of participant in the action.; (xsd)typeCanonical:CapabilityStatement*>?
< The type of participant in the action. When this element is a reference, it SHOULD be a reference to a definitional resource (for example, a location type, rather than a specific location).; (xsd)typeReference:(<CareTeam>
|<Device>
|<DeviceDefinition>
|<Endpoint>
|<Group>
|<HealthcareService>
|<Location>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>?
< The role the participant should play in performing the described action. Binding: http://terminology.hl7.org/ValueSet/action-participant-role (example, Defines roles played by participants for the action.); (xsd)role:CodeableConcept>?
< Indicates how the actor will be involved in the action - author, reviewer, witness, etc. Binding: action-participant-function (example, ); (xsd)function:CodeableConcept>?
< A reference to the actual participant.; (xsd)actor:(<CapabilityStatement>
|<CareTeam>
|<Device>
|<DeviceDefinition>
|<Endpoint>
|<Group>
|<HealthcareService>
|<Location>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>?🔗 A relationship to another action such as "before" or "30-60 minutes after start of".cdshooksrequestorchestration.action.relatedAction(xsd)(doc)=
<#base:RequestOrchestration.action.relatedAction>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The element id of the target related action.; (xsd)targetId:id>
< The relationship of this action to the related action. Binding: action-relationship-type (required, Defines the types of relationships between actions.); (xsd)relationship:code>
< The relationship of the end of this action to the related action. Binding: action-relationship-type (required, Defines the types of relationships between actions.); (xsd)endRelationship:code>?
< A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.; (xsd)offset:(<Duration>
|<Range>)>?🔗 This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical and non-clinical artifacts such as clinical decision support rules, order sets, protocols, and drug quality specifications.cdshooksserviceplandefinition(xsd)(doc)=
<#base:PlanDefinition>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< An Extension; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< An absolute URI that is used to identify this plan definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this plan definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the plan definition is stored on different servers. Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.
The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions).
In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.; (xsd)url:uri>?
[]< A formal identifier that is used to identify this plan definition when it is represented in other formats, or referenced in a specification, model, design or an instance. Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this plan definition outside of FHIR, where it is not possible to use the logical URI.; (xsd)identifier:Identifier>*
< The identifier that is used to identify this version of the plan definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the plan definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts. There may be different plan definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the plan definition with the format [url]|[version]. The version SHOULD NOT contain a '#' - see [Business Version](resource.html#bv-format).; (xsd)version:string>?
< Indicates the mechanism used to compare versions to determine which is more current. If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined. Binding: version-algorithm (extensible, ); (xsd)versionAlgorithm:(<Coding>
|<string>)>?
< A natural language name identifying the plan definition. This name should be usable as an identifier for the module by machine processing applications such as code generation. The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.; (xsd)name:string>?
< A short, descriptive, user-friendly title for the plan definition. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.; (xsd)title:string>?
< An explanatory or alternate title for the plan definition giving additional information about its content.; (xsd)subtitle:string>?
< A high-level category for the plan definition that distinguishes the kinds of systems that would be interested in the plan definition. Binding: plan-definition-type (extensible, The type of PlanDefinition.); (xsd)type:CodeableConcept>?
< The status of this plan definition. Enables tracking the life-cycle of the content. Allows filtering of plan definitions that are appropriate for use versus not.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization). Binding: publication-status (required, The lifecycle status of an artifact.); (xsd)status:code>
< A Boolean value to indicate that this plan definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. Allows filtering of plan definitions that are appropriate for use versus not.; (xsd)experimental:boolean>?
< A code, group definition, or canonical reference that describes or identifies the intended subject of the plan definition. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource. Note that the choice of canonical for the subject element was introduced in R4B to support pharmaceutical quality use cases. To ensure as much backwards-compatibility as possible, it is recommended to only use the new canonical type with these use cases. Binding: participant-resource-types (extensible, The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).); (xsd)subject:(<AdministrableProductDefinition>
|<CodeableConcept>
|<EvidenceVariable>
|<Group>
|<ManufacturedItemDefinition>
|<MedicinalProductDefinition>
|<PackagedProductDefinition>
|<SubstanceDefinition>)>?
< The date (and optionally time) when the plan definition was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the plan definition changes. The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the plan definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)date:dateTime>?
< The name of the organization or individual responsible for the release and ongoing maintenance of the plan definition. Usually an organization but may be an individual. The publisher (or steward) of the plan definition is the organization or individual primarily responsible for the maintenance and upkeep of the plan definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the plan definition. This item SHOULD be populated unless the information is available from context.; (xsd)publisher:string>?
[]< Contact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)contact:ContactDetail>*
< A free text natural language description of the plan definition from a consumer's perspective. This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the plan definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the plan definition is presumed to be the predominant language in the place the plan definition was created).; (xsd)description:markdown>?
[]< The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate plan definition instances. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.; (xsd)useContext:UsageContext>*
[]< A legal or geographic region in which the plan definition is intended to be used. It may be possible for the plan definition to be used in jurisdictions other than those for which it was originally designed or intended.
DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.) Binding: jurisdiction (extensible, Countries and regions within which this artifact is targeted for use.); (xsd)jurisdiction:CodeableConcept>*
< Explanation of why this plan definition is needed and why it has been designed as it has. This element does not describe the usage of the plan definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this plan definition.; (xsd)purpose:markdown>?
< A detailed description of how the plan definition is used from a clinical perspective.; (xsd)usage:markdown>?
< A copyright statement relating to the plan definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the plan definition. The short copyright declaration (e.g. (c) '2015+ xyz organization' should be sent in the copyrightLabel element.; (xsd)copyright:markdown>?
< A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved'). The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.; (xsd)copyrightLabel:string>?
< The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)approvalDate:date>?
< The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. If specified, this date follows the original approval date.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)lastReviewDate:date>?
< The period during which the plan definition content was or is planned to be in active use. The effective period for a plan definition determines when the content is applicable for usage and is independent of publication and review dates. For example, a plan definition intended to be used for the year 2016 might be published in 2015.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)effectivePeriod:Period>?
[]< Descriptive topics related to the content of the plan definition. Topics provide a high-level categorization of the definition that can be useful for filtering and searching. DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'topic' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#topic and useContext.valueCodeableConcept indicating the topic) Binding: definition-topic (example, High-level categorization of the definition, used for searching, sorting, and filtering.); (xsd)topic:CodeableConcept>*
[]< An individiual or organization primarily involved in the creation and maintenance of the content.; (xsd)author:ContactDetail>*
[]< An individual or organization primarily responsible for internal coherence of the content.; (xsd)editor:ContactDetail>*
[]< An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the content. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)reviewer:ContactDetail>*
[]< An individual or organization asserted by the publisher to be responsible for officially endorsing the content for use in some setting. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)endorser:ContactDetail>*
[]< Related artifacts such as additional documentation, justification, or bibliographic references. Each related artifact is either an attachment, or a reference to another resource, but not both.; (xsd)relatedArtifact:RelatedArtifact>*
[]< A reference to a Library resource containing any formal logic used by the plan definition.; (xsd)library:Library*>*
[]< A goal describes an expected outcome that activities within the plan are intended to achieve. For example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, meeting the acceptance criteria for a test as specified by a quality specification, etc.; (xsd)goal:cdshooksserviceplandefinition.goal>*
[]< Actors represent the individuals or groups involved in the execution of the defined set of activities.; (xsd)actor:cdshooksserviceplandefinition.actor>*
[]< An action or group of actions to be taken as part of the plan. For example, in clinical care, an action would be to prescribe a particular indicated medication, or perform a particular test as appropriate. In pharmaceutical quality, an action would be the test that needs to be performed on a drug product as defined in the quality specification. Note that there is overlap between many of the elements defined here and the ActivityDefinition resource. When an ActivityDefinition is referenced (using the definition element), the overlapping elements in the plan override the content of the referenced ActivityDefinition unless otherwise documented in the specific elements. See the PlanDefinition resource for more detailed information.; (xsd)action:cdshooksserviceplandefinition.action>*
< If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example "pain", "on flare-up", etc. Binding: medication-as-needed-reason (example, A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc.); (xsd)asNeeded:(<boolean>
|<CodeableConcept>)>?
< Defines the service endpoint for the behavior implemented by the PlanDefinition.; (xsd)cdsHooksEndpoint:Extension>🔗 An action or group of actions to be taken as part of the plan. For example, in clinical care, an action would be to prescribe a particular indicated medication, or perform a particular test as appropriate. In pharmaceutical quality, an action would be the test that needs to be performed on a drug product as defined in the quality specification. Note that there is overlap between many of the elements defined here and the ActivityDefinition resource. When an ActivityDefinition is referenced (using the definition element), the overlapping elements in the plan override the content of the referenced ActivityDefinition unless otherwise documented in the specific elements. See the PlanDefinition resource for more detailed information.cdshooksserviceplandefinition.action(xsd)(doc)=
<#base:PlanDefinition.action>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< An identifier that is unique within the PlanDefinition to allow linkage within the realized CarePlan and/or RequestOrchestration.; (xsd)linkId:string>?
< A user-visible prefix for the action. For example a section or item numbering such as 1. or A.; (xsd)prefix:string>?
< The textual description of the action displayed to a user. For example, when the action is a test to be performed, the title would be the title of the test such as Assay by HPLC.; (xsd)title:string>?
< A brief description of the action used to provide a summary to display to the user.; (xsd)description:markdown>?
< A text equivalent of the action to be performed. This provides a human-interpretable description of the action when the definition is consumed by a system that might not be capable of interpreting it dynamically.; (xsd)textEquivalent:markdown>?
< Indicates how quickly the action should be addressed with respect to other actions. Binding: request-priority (required, Identifies the level of importance to be assigned to actioning the request.); (xsd)priority:code>?
< A code that provides a meaning, grouping, or classification for the action or action group. For example, a section may have a LOINC code for the section of a documentation template. In pharmaceutical quality, an action (Test) such as pH could be classified as a physical property. Binding: action-code (example, Provides examples of actions to be performed.); (xsd)code:CodeableConcept>?
[]< A description of why this action is necessary or appropriate. This is different than the clinical evidence documentation, it's an actual business description of the reason for performing the action. Binding: action-reason-code (example, Provides examples of reasons for actions to be performed.); (xsd)reason:CodeableConcept>*
[]< Didactic or other informational resources associated with the action that can be provided to the CDS recipient. Information resources can include inline text commentary and links to web resources.; (xsd)documentation:RelatedArtifact>*
[]< Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition. In pharmaceutical quality, a goal represents acceptance criteria (Goal) for a given action (Test), so the goalId would be the unique id of a defined goal element establishing the acceptance criteria for the action.; (xsd)goalId:id>*
< A code, group definition, or canonical reference that describes the intended subject of the action and its children, if any. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource. The subject of an action overrides the subject at a parent action or on the root of the PlanDefinition if specified.
In addition, because the subject needs to be resolved during realization, use of subjects in actions (or in the ActivityDefinition referenced by the action) resolves based on the set of subjects supplied in context and by type (i.e. the patient subject would resolve to a resource of type Patient). Binding: participant-resource-types (extensible, The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).); (xsd)subject:(<CodeableConcept>
|<Group>
|<Resource>)>?
[]< A description of when the action should be triggered. When multiple triggers are specified on an action, any triggering event invokes the action.; (xsd)trigger:TriggerDefinition>*
[]< An expression that describes applicability criteria or start/stop conditions for the action. When multiple conditions of the same kind are present, the effects are combined using AND semantics, so the overall condition is true only if all the conditions are true.; (xsd)condition:cdshooksserviceplandefinition.action.condition>*
[]< Defines input data requirements for the action.; (xsd)input:cdshooksserviceplandefinition.action.input>*
[]< Defines the outputs of the action, if any.; (xsd)output:cdshooksserviceplandefinition.action.output>*
[]< A relationship to another action such as "before" or "30-60 minutes after start of". When an action depends on multiple actions, the meaning is that all actions are dependencies, rather than that any of the actions are a dependency.; (xsd)relatedAction:cdshooksserviceplandefinition.action.relatedAction>*
< An optional value describing when the action should be performed. The intent of the timing element is to provide timing when the action should be performed. As a definitional resource, this timing is interpreted as part of an apply operation so that the timing of the result actions in a CarePlan or RequestOrchestration, for example, would be specified by evaluating the timing definition in the context of the apply and setting the resulting timing on the appropriate elements of the target resource. If the timing is an Age, the activity is expected to be performed when the subject is the given Age. When the timing is a Duration, the activity is expected to be performed within the specified duration from the apply. When the timing is a Range, it may be a range of Ages or Durations, providing a range for the expected timing of the resulting activity. When the timing is a Timing, it is establishing a schedule for the timing of the resulting activity.; (xsd)timing:(<Age>
|<Duration>
|<Range>
|<Timing>)>?
< Identifies the facility where the action will occur; e.g. home, hospital, specific clinic, etc. May reference a specific clinical location or may just identify a type of location.; (xsd)location:Location*>?
[]< Indicates who should participate in performing the action described.; (xsd)participant:cdshooksserviceplandefinition.action.participant>*
< The type of action to perform (create, update, remove). Binding: action-type (extensible, The type of action to be performed.); (xsd)type:CodeableConcept>?
< Defines the grouping behavior for the action and its children. Binding: action-grouping-behavior (required, Defines organization behavior of a group.); (xsd)groupingBehavior:code>?
< Defines the selection behavior for the action and its children. Binding: action-selection-behavior (required, Defines selection behavior of a group.); (xsd)selectionBehavior:code>?
< Defines the required behavior for the action. Binding: action-required-behavior (required, Defines expectations around whether an action or action group is required.); (xsd)requiredBehavior:code>?
< Defines whether the action should usually be preselected. Binding: action-precheck-behavior (required, Defines selection frequency behavior for an action or group.); (xsd)precheckBehavior:code>?
< Defines whether the action can be selected multiple times. Binding: action-cardinality-behavior (required, Defines behavior for an action or a group for how many times that item may be repeated.); (xsd)cardinalityBehavior:code>?
< A reference to an ActivityDefinition that describes the action to be taken in detail, a MessageDefinition describing a message to be snet, a PlanDefinition that describes a series of actions to be taken, a Questionnaire that should be filled out, a SpecimenDefinition describing a specimen to be collected, or an ObservationDefinition that specifies what observation should be captured. Note that the definition is optional, and if no definition is specified, a dynamicValue with a root ($this) path can be used to define the entire resource dynamically.; (xsd)definition:(<ActivityDefinition>
|<MessageDefinition>
|<ObservationDefinition>
|<PlanDefinition>
|<Questionnaire>
|<SpecimenDefinition>
|<uri>)>?
< A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input. Note that when a referenced ActivityDefinition also defines a transform, the transform specified here generally takes precedence. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.; (xsd)transform:StructureMap*>?
[]< Customizations that should be applied to the statically defined resource. For example, if the dosage of a medication must be computed based on the patient's weight, a customization would be used to specify an expression that calculated the weight, and the path on the resource that would contain the result. Dynamic values are applied in the order in which they are defined in the PlanDefinition resource. Note that when dynamic values are also specified by a referenced ActivityDefinition, the dynamicValues from the ActivityDefinition are applied first, followed by the dynamicValues specified here. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.; (xsd)dynamicValue:cdshooksserviceplandefinition.action.dynamicValue>*
[]< Sub actions that are contained within the action. The behavior of this action determines the functionality of the sub-actions. For example, a selection behavior of at-most-one indicates that of the sub-actions, at most one may be chosen as part of realizing the action definition.; (xsd)action:PlanDefinition.action>*🔗 An expression that describes applicability criteria or start/stop conditions for the action. When multiple conditions of the same kind are present, the effects are combined using AND semantics, so the overall condition is true only if all the conditions are true.cdshooksserviceplandefinition.action.condition(xsd)(doc)=
<#base:PlanDefinition.action.condition>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The kind of condition. Applicability criteria are used to determine immediate applicability when a plan definition is applied to a given context. Start and stop criteria are carried through application and used to describe enter/exit criteria for an action. Binding: action-condition-kind (required, Defines the kinds of conditions that can appear on actions.); (xsd)kind:code>
< An expression that returns true or false, indicating whether the condition is satisfied. The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.; (xsd)expression:Expression>?🔗 Customizations that should be applied to the statically defined resource. For example, if the dosage of a medication must be computed based on the patient's weight, a customization would be used to specify an expression that calculated the weight, and the path on the resource that would contain the result. Dynamic values are applied in the order in which they are defined in the PlanDefinition resource. Note that when dynamic values are also specified by a referenced ActivityDefinition, the dynamicValues from the ActivityDefinition are applied first, followed by the dynamicValues specified here. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.cdshooksserviceplandefinition.action.dynamicValue(xsd)(doc)=
<#base:PlanDefinition.action.dynamicValue>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The path to the element to be customized. This is the path on the resource that will hold the result of the calculation defined by the expression. The specified path SHALL be a FHIRPath resolvable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. 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). To specify the path to the current action being realized, the %action environment variable is available in this path. For example, to specify the description element of the target action, the path would be %action.description. The path attribute contains a [Simple FHIRPath Subset](fhirpath.html#simple) that allows path traversal, but not calculation.; (xsd)path:string>?
< An expression specifying the value of the customized element. The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.; (xsd)expression:Expression>?🔗 Defines input data requirements for the action.cdshooksserviceplandefinition.action.input(xsd)(doc)=
<#base:PlanDefinition.action.input>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A human-readable label for the data requirement used to label data flows in BPMN or similar diagrams. Also provides a human readable label when rendering the data requirement that conveys its purpose to human readers.; (xsd)title:string>?
< Defines the data that is to be provided as input to the action.; (xsd)requirement:DataRequirement>?
< Points to an existing input or output element that provides data to this input. The relatedData element allows indicating that an input to a parent action is an input to specific child actions. It also allows the output of one action to be identified as the input to a different action; (xsd)relatedData:id>?🔗 Defines the outputs of the action, if any.cdshooksserviceplandefinition.action.output(xsd)(doc)=
<#base:PlanDefinition.action.output>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A human-readable label for the data requirement used to label data flows in BPMN or similar diagrams. Also provides a human readable label when rendering the data requirement that conveys its purpose to human readers.; (xsd)title:string>?
< Defines the data that results as output from the action.; (xsd)requirement:DataRequirement>?
< Points to an existing input or output element that is results as output from the action. The relatedData element allows indicating that the output of child action is also the output of a parent action. It also allows the input of one action to be identified as the output of a different action; (xsd)relatedData:string>?🔗 Indicates who should participate in performing the action described.cdshooksserviceplandefinition.action.participant(xsd)(doc)=
<#base:PlanDefinition.action.participant>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A reference to the id element of the actor who will participate in this action.; (xsd)actorId:string>?
< The type of participant in the action. Binding: action-participant-type (required, The type of participant in the activity.); (xsd)type:code>?
< The type of participant in the action.; (xsd)typeCanonical:CapabilityStatement*>?
< The type of participant in the action. When this element is a reference, it SHOULD be a reference to a definitional resource (for example, a location type, rather than a specific location).; (xsd)typeReference:(<CareTeam>
|<Device>
|<DeviceDefinition>
|<Endpoint>
|<Group>
|<HealthcareService>
|<Location>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>?
< The role the participant should play in performing the described action. Binding: http://terminology.hl7.org/ValueSet/action-participant-role (example, Defines roles played by participants for the action.); (xsd)role:CodeableConcept>?
< Indicates how the actor will be involved in the action - author, reviewer, witness, etc. Binding: action-participant-function (example, ); (xsd)function:CodeableConcept>?🔗 A relationship to another action such as "before" or "30-60 minutes after start of". When an action depends on multiple actions, the meaning is that all actions are dependencies, rather than that any of the actions are a dependency.cdshooksserviceplandefinition.action.relatedAction(xsd)(doc)=
<#base:PlanDefinition.action.relatedAction>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The element id of the target related action.; (xsd)targetId:id>
< The relationship of the start of this action to the related action. Binding: action-relationship-type (required, Defines the types of relationships between actions.); (xsd)relationship:code>
< The relationship of the end of this action to the related action. Binding: action-relationship-type (required, Defines the types of relationships between actions.); (xsd)endRelationship:code>?
< A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.; (xsd)offset:(<Duration>
|<Range>)>?🔗 Actors represent the individuals or groups involved in the execution of the defined set of activities.cdshooksserviceplandefinition.actor(xsd)(doc)=
<#base:PlanDefinition.actor>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A descriptive label for the actor.; (xsd)title:string>?
< A description of how the actor fits into the overall actions of the plan definition.; (xsd)description:markdown>?
[]< The characteristics of the candidates that could serve as the actor.; (xsd)option:cdshooksserviceplandefinition.actor.option>+🔗 The characteristics of the candidates that could serve as the actor.cdshooksserviceplandefinition.actor.option(xsd)(doc)=
<#base:PlanDefinition.actor.option>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The type of participant in the action. Binding: action-participant-type (required, The type of participant in the activity.); (xsd)type:code>?
< The type of participant in the action.; (xsd)typeCanonical:CapabilityStatement*>?
< The type of participant in the action. When this element is a reference, it SHOULD be a reference to a definitional resource (for example, a location type, rather than a specific location).; (xsd)typeReference:(<CareTeam>
|<Device>
|<DeviceDefinition>
|<Endpoint>
|<Group>
|<HealthcareService>
|<Location>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>?
< The role the participant should play in performing the described action. Binding: http://terminology.hl7.org/ValueSet/action-participant-role (example, ); (xsd)role:CodeableConcept>?🔗 A goal describes an expected outcome that activities within the plan are intended to achieve. For example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, meeting the acceptance criteria for a test as specified by a quality specification, etc.cdshooksserviceplandefinition.goal(xsd)(doc)=
<#base:PlanDefinition.goal>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Indicates a category the goal falls within. Binding: goal-category (example, Example codes for grouping goals for filtering or presentation.); (xsd)category:CodeableConcept>?
< Human-readable and/or coded description of a specific desired objective of care, such as "control blood pressure" or "negotiate an obstacle course" or "dance with child at wedding". If no code is available, use CodeableConcept.text. Binding: clinical-findings (example, Describes goals that can be achieved.); (xsd)description:CodeableConcept>
< Identifies the expected level of importance associated with reaching/sustaining the defined goal. Binding: goal-priority (preferred, Indicates the level of importance associated with reaching or sustaining a goal.); (xsd)priority:CodeableConcept>?
< The event after which the goal should begin being pursued. Binding: goal-start-event (example, Identifies the types of events that might trigger the start of a goal.); (xsd)start:CodeableConcept>?
[]< Identifies problems, conditions, issues, or concerns the goal is intended to address. Binding: condition-code (example, Identifies problems, conditions, issues, or concerns that goals may address.); (xsd)addresses:CodeableConcept>*
[]< Didactic or other informational resources associated with the goal that provide further supporting information about the goal. Information resources can include inline text commentary and links to web resources.; (xsd)documentation:RelatedArtifact>*
[]< Indicates what should be done and within what timeframe.; (xsd)target:cdshooksserviceplandefinition.goal.target>*🔗 Indicates what should be done and within what timeframe.cdshooksserviceplandefinition.goal.target(xsd)(doc)=
<#base:PlanDefinition.goal.target>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The parameter whose value is to be tracked, e.g. body weight, blood pressure, or hemoglobin A1c level. Binding: observation-codes (example, Identifies types of parameters that can be tracked to determine goal achievement.); (xsd)measure:CodeableConcept>?
< The target value of the measure to be achieved to signify fulfillment of the goal, e.g. 150 pounds or 7.0%, or in the case of pharmaceutical quality - NMT 0.6%, Clear solution, etc. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any value at or above the low value. A CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the goal.target.measure defines a coded value.; (xsd)detail:(<boolean>
|<CodeableConcept>
|<integer>
|<Quantity>
|<Range>
|<Ratio>
|<string>)>?
< Indicates the timeframe after the start of the goal in which the goal should be met.; (xsd)due:Duration>?🔗 The Citation Resource enables reference to any knowledge artifact for purposes of identification and attribution. The Citation Resource supports existing reference structures and developing publication practices such as versioning, expressing complex contributorship roles, and referencing computable resources.Citation(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< An absolute URI that is used to identify this citation record when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this summary is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the summary is stored on different servers. In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found.; (xsd)url:uri>?
[]< A formal identifier that is used to identify this citation record when it is represented in other formats, or referenced in a specification, model, design or an instance. Use this element if you need to identify the citation record independently from identifying the cited artifact.; (xsd)identifier:Identifier>*
< The identifier that is used to identify this version of the citation record when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the citation record author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. There may be different citation record instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the citation record with the format [url]|[version]. The version SHOULD NOT contain a '#' - see [Business Version](resource.html#bv-format).; (xsd)version:string>?
< Indicates the mechanism used to compare versions to determine which is more current. If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 is newer, and a 0 if the version ordering can't successfully be determined. Binding: version-algorithm (extensible, ); (xsd)versionAlgorithm:(<Coding>
|<string>)>?
< A natural language name identifying the citation record. This name should be usable as an identifier for the module by machine processing applications such as code generation. The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.; (xsd)name:string>?
< A short, descriptive, user-friendly title for the citation record. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc. Use this element if you have a need for naming the citation record for human use, such as a display name for the citation record that is used when selecting citations from a list.; (xsd)title:string>?
< The status of this summary. Enables tracking the life-cycle of the content. Allows filtering of summaries that are appropriate for use versus not. Use "active" when the citation record is the version for others to actively use, "draft" while you are developing the content, and "retired" when this record should no longer be used for any purpose.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization). Binding: publication-status (required, ); (xsd)status:code>
< A Boolean value to indicate that this citation record is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. Allows filtering of citation records that are appropriate for use versus not.; (xsd)experimental:boolean>?
< The date (and optionally time) when the citation record was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the citation record changes. The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the citation record. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)date:dateTime>?
< The name of the organization or individual that published the citation record. Usually an organization but may be an individual. The publisher (or steward) of the citation record is the organization or individual primarily responsible for the maintenance and upkeep of the citation record. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the citation record. This item SHOULD be populated unless the information is available from context.; (xsd)publisher:string>?
[]< Contact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)contact:ContactDetail>*
< A free text natural language description of the citation from a consumer's perspective. This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the citation as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the citation is presumed to be the predominant language in the place the citation was created).; (xsd)description:markdown>?
[]< The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate citation record instances. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.; (xsd)useContext:UsageContext>*
[]< A legal or geographic region in which the citation record is intended to be used. It may be possible for the citation record to be used in jurisdictions other than those for which it was originally designed or intended.
DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.) Binding: jurisdiction (extensible, ); (xsd)jurisdiction:CodeableConcept>*
< Explanation of why this citation is needed and why it has been designed as it has. This element does not describe the usage of the citation. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this citation.; (xsd)purpose:markdown>?
< Use and/or publishing restrictions for the citation record, not for the cited artifact.; (xsd)copyright:markdown>?
< A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved'). The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.; (xsd)copyrightLabel:string>?
< The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)approvalDate:date>?
< The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. If specified, this date follows the original approval date.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)lastReviewDate:date>?
< The period during which the citation record content was or is planned to be in active use. The effective period for a citation record determines when the content is applicable for usage and is independent of publication and review dates. For example, a citation intended to be used for the year 2016 might be published in 2015.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)effectivePeriod:Period>?
[]< Who authored or created the citation record. The Citation.author element is structured to support a name (with a string datatype) and contact point information for the author/creator, and is not structured to support unique identifiers for the author. If detailed contributorship data is needed for the authorship of the citation record, then one can create a Citation Resource for the Citation Resource.; (xsd)author:ContactDetail>*
[]< Who edited or revised the citation record. The Citation.editor element is structured to support a name (with a string datatype) and contact point information for the editor, and is not structured to support unique identifiers for the editor. If detailed contributorship data is needed for the editing of the citation record, then one can create a Citation Resource for the Citation Resource.; (xsd)editor:ContactDetail>*
[]< Who reviewed the citation record. The Citation.reviewer element is structured to support a name (with a string datatype) and contact point information for the reviewer, and is not structured to support unique identifiers for the reviewer. If detailed contributorship data is needed for the review of the citation record, then one can create a Citation Resource for the Citation Resource.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)reviewer:ContactDetail>*
[]< Who endorsed the citation record. The Citation.endorser element is structured to support a name (with a string datatype) and contact point information for the endorser, and is not structured to support unique identifiers for the endorser. If detailed contributorship data is needed for the endorsement of the citation record, then one can create a Citation Resource for the Citation Resource.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)endorser:ContactDetail>*
[]< A human-readable display of key concepts to represent the citation.; (xsd)summary:Citation.summary>*
[]< The assignment to an organizing scheme. Use this element if you need to classify the citation record independently from classifying the cited artifact.; (xsd)classification:Citation.classification>*
[]< Used for general notes and annotations not coded elsewhere.; (xsd)note:Annotation>*
[]< The status of the citation record. Use this if needed for reporting the state or status of the citation record, NOT FOR reporting the state or status of the cited article. Binding: citation-status-type (example, ); (xsd)currentState:CodeableConcept>*
[]< The state or status of the citation record paired with an effective date or period for that state. Use this if needed for reporting the state or status of the citation record, NOT FOR reporting the state or status of the cited article.; (xsd)statusDate:Citation.statusDate>*
[]< Artifact related to the citation record. Use this if needed for reporting artifacts related to the citation record, NOT FOR reporting artifacts related to the cited article. For example, one may use this element to report the data source for generation of the Citation Resource instance if it was automatically generated, such as conversion from a citation repository.; (xsd)relatedArtifact:RelatedArtifact>*
< The article or artifact being described.; (xsd)citedArtifact:Citation.citedArtifact>?🔗 The article or artifact being described.Citation.citedArtifact(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< A formal identifier that is used to identify the cited artifact when it is represented in other formats, or referenced in a specification, model, design or an instance. This element will contain unique identifiers that support de-duplication of citations. Commonly used identifiers for study citations include digital object identifier (DOI), PubMed ID (PMID), and PubMed Central ID (PMCID). To maintain interoperability, the suggested identifier.system values to use for these 3 identifiers are: DOI = "https://doi.org" PMID = "https://pubmed.ncbi.nlm.nih.gov" PMCID = "https://www.ncbi.nlm.nih.gov/pmc/"; (xsd)identifier:Identifier>*
[]< A formal identifier that is used to identify things closely related to the cited artifact. May include trial registry identifiers, e.g. NCT04372602 from clinicaltrials.gov. This related identifier would not be used as unique identifier for the cited artifact itself. Multiple published articles (each with their own unique identifier) may relate to the same study record in a research registry. Commonly used related identifiers for study registries include ClinicalTrials.gov identifier (NCTId) and PROSPERO identifier (used for registration of systematic reviews). To maintain interoperability, the suggested identifier.system values to use for these 2 identifiers are: ClinicalTrials.gov = "https://clinicaltrials.gov" PROSPERO = "https://www.crd.york.ac.uk/prospero/"; (xsd)relatedIdentifier:Identifier>*
< When the cited artifact was accessed. Use this element when citing an artifact from a potentially unstable source, such as a webpage, to note the date (and time) the source was accessed.; (xsd)dateAccessed:dateTime>?
< The defined version of the cited artifact.; (xsd)version:Citation.citedArtifact.version>?
[]< The status of the cited artifact. Binding: cited-artifact-status-type (extensible, ); (xsd)currentState:CodeableConcept>*
[]< An effective date or period, historical or future, actual or expected, for a status of the cited artifact.; (xsd)statusDate:Citation.citedArtifact.statusDate>*
[]< The title details of the article or artifact.; (xsd)title:Citation.citedArtifact.title>*
[]< The abstract may be used to convey article-contained abstracts, externally-created abstracts, or other descriptive summaries.; (xsd)abstract:Citation.citedArtifact.abstract>*
< The component of the article or artifact.; (xsd)part:Citation.citedArtifact.part>?
[]< The artifact related to the cited artifact. The citedArtifact.relatesTo element uses a BackboneElement instead of the RelatedArtifact Datatype to enable use of an extended value set for the required code for the type of relationship.; (xsd)relatesTo:Citation.citedArtifact.relatesTo>*
[]< If multiple, used to represent alternative forms of the article that are not separate citations. A common use is a journal article with a publication date and pagination for a print version and a different publication date for the online version of the same article.; (xsd)publicationForm:Citation.citedArtifact.publicationForm>*
[]< Used for any URL for the article or artifact cited.; (xsd)webLocation:Citation.citedArtifact.webLocation>*
[]< The assignment to an organizing scheme.; (xsd)classification:Citation.citedArtifact.classification>*
< This element is used to list authors and other contributors, their contact information, specific contributions, and summary statements.; (xsd)contributorship:Citation.citedArtifact.contributorship>?
[]< Any additional information or content for the article or artifact.; (xsd)note:Annotation>*🔗 The abstract may be used to convey article-contained abstracts, externally-created abstracts, or other descriptive summaries.Citation.citedArtifact.abstract(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Used to express the reason for or classification of the abstract. Binding: cited-artifact-abstract-type (extensible, ); (xsd)type:CodeableConcept>?
< Used to express the specific language of the abstract. Binding: languages (preferred, A human language.); (xsd)language:CodeableConcept>?
< Abstract content.; (xsd)text:markdown>
< Copyright notice for the abstract. There is also a copyright element in the publicationForm element, so this copyright element is intended for copyright of the abstract.; (xsd)copyright:markdown>?🔗 The assignment to an organizing scheme.Citation.citedArtifact.classification(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The kind of classifier (e.g. publication type, keyword). Binding: cited-artifact-classification-type (extensible, ); (xsd)type:CodeableConcept>?
[]< The specific classification value. Binding: citation-artifact-classifier (example, ); (xsd)classifier:CodeableConcept>*
[]< Complex or externally created classification. Examples relevant to study citations include MeSH Headings or Keywords that contain qualifier codings or sub-classifications, and include risk of bias assessments created by persons different from the creator of the citation record.; (xsd)artifactAssessment:ArtifactAssessment*>*🔗 This element is used to list authors and other contributors, their contact information, specific contributions, and summary statements.Citation.citedArtifact.contributorship(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Indicates if the list includes all authors and/or contributors. If list is incomplete, "et al" can be appended to Contributorship.summary.value for display purposes.; (xsd)complete:boolean>?
[]< An individual entity named as a contributor, for example in the author list or contributor list. Used to report contributorship in individualized ways.; (xsd)entry:Citation.citedArtifact.contributorship.entry>*
[]< Used to record a display of the author/contributor list without separate data element for each list member.; (xsd)summary:Citation.citedArtifact.contributorship.summary>*🔗 An individual entity named as a contributor, for example in the author list or contributor list. Used to report contributorship in individualized ways.Citation.citedArtifact.contributorship.entry(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The identity of the individual contributor. If naming a contributor without additional detail or further structured data, the display element within the Reference datatype may be used for a simple string without referencing another resource.; (xsd)contributor:(<Organization>
|<Practitioner>)>
< For citation styles that use initials. This element is used to support a data element used for citations that is not otherwise supported fully by FHIR HumanName datatype. In some citation summary styles (e.g. Medline), authors are presented with full spelling of their last name (family name) and initials for all forenames (first names, middle names, preceding names, given names). As the FHIR HumanName Datatype does not have a specific element for forename initials and this is common in citation usage, the element is added to contributorship.entry directly.; (xsd)forenameInitials:string>?
[]< Organization affiliated with the contributor. If naming an organization without additional detail or further structured data, the display element within the Reference datatype may be used for a simple string without referencing another resource.; (xsd)affiliation:(<Organization>
|<PractitionerRole>)>*
[]< This element identifies the specific nature of an individual’s contribution with respect to the cited work. The CreDiT taxonomy provides a way to encode contribution information. The purpose of CRediT is to provide transparency in contributions to scholarly published work, to enable improved systems of attribution, credit, and accountability. Binding: artifact-contribution-type (extensible, ); (xsd)contributionType:CodeableConcept>*
< The role of the contributor (e.g. author, editor, reviewer, funder). Binding: contributor-role (extensible, ); (xsd)role:CodeableConcept>?
[]< Contributions with accounting for time or number.; (xsd)contributionInstance:Citation.citedArtifact.contributorship.entry.contributionInstance>*
< Whether the contributor is the corresponding contributor for the role. If there are multiple authors and one serves as the corresponding author, then that one would have correspondingContact = true.; (xsd)correspondingContact:boolean>?
< Provides a numerical ranking to represent the degree of contributorship relative to other contributors, such as 1 for first author and 2 for second author. Used to retain order of authorship as structured data; (xsd)rankingOrder:positiveInt>?🔗 Contributions with accounting for time or number.Citation.citedArtifact.contributorship.entry.contributionInstance(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The specific contribution. Binding: artifact-contribution-instance-type (extensible, ); (xsd)type:CodeableConcept>
< The time that the contribution was made.; (xsd)time:dateTime>?🔗 Used to record a display of the author/contributor list without separate data element for each list member.Citation.citedArtifact.contributorship.summary(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Used most commonly to express an author list or a contributorship statement. Binding: contributor-summary-type (extensible, ); (xsd)type:CodeableConcept>?
< The format for the display string, such as author last name with first letter capitalized followed by forename initials. Binding: contributor-summary-style (extensible, ); (xsd)style:CodeableConcept>?
< Used to code the producer or rule for creating the display string. Binding: contributor-summary-source (extensible, ); (xsd)source:CodeableConcept>?
< The display string for the author list, contributor list, or contributorship statement.; (xsd)value:markdown>🔗 The component of the article or artifact.Citation.citedArtifact.part(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The kind of component. Binding: cited-artifact-part-type (extensible, ); (xsd)type:CodeableConcept>?
< The specification of the component.; (xsd)value:string>?
< The citation for the full article or artifact. When referencing a baseCitation, one may inherit any data from the referenced Citation Resource and consider any data in the current Citation Resource as superceding to be specific to the citation of the specified part. For example, the part-specific Citation may have additional contributorship data that supercedes the contributorship data for the full citation when there is a need to uniquely report the contributorship for an image or supplement associated with the fuller citation record.; (xsd)baseCitation:Citation*>?🔗 If multiple, used to represent alternative forms of the article that are not separate citations. A common use is a journal article with a publication date and pagination for a print version and a different publication date for the online version of the same article.Citation.citedArtifact.publicationForm(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The collection the cited article or artifact is published in.; (xsd)publishedIn:Citation.citedArtifact.publicationForm.publishedIn>?
< Describes the form of the medium cited. Common codes are "Internet" or "Print". The CitedMedium value set has 6 codes. The codes internet, print, and offline-digital-storage are the common codes for a typical publication form, though internet and print are more common for study citations. Three additional codes (each appending one of the primary codes with "-without-issue" are used for situations when a study is published both within an issue (of a periodical release as commonly done for journals) AND is published separately from the issue (as commonly done with early online publication), to represent specific identification of the publication form not associated with the issue. Binding: cited-medium (extensible, ); (xsd)citedMedium:CodeableConcept>?
< Volume number of journal or other collection in which the article is published.; (xsd)volume:string>?
< Issue, part or supplement of journal or other collection in which the article is published.; (xsd)issue:string>?
< The date the article was added to the database, or the date the article was released. The articleDate is the preferred element for expressing the publication date as structured data.; (xsd)articleDate:dateTime>?
< Text representation of the date on which the issue of the cited artifact was published. The publicationDateText element is prefererntially used when a date is not represented in a form that can be handled as structured data in other elements.; (xsd)publicationDateText:string>?
< Spring, Summer, Fall/Autumn, Winter.; (xsd)publicationDateSeason:string>?
< The date the article was last revised or updated in the database. The lastRevisionDate is used for the cited article and not the date the Citation Resource is last revised.; (xsd)lastRevisionDate:dateTime>?
[]< The language or languages in which this form of the article is published. Binding: languages (preferred, A human language.); (xsd)language:CodeableConcept>*
< Entry number or identifier for inclusion in a database. Accession numbers may be used instead of or in addition to page numbers. Accession numbers are functionally identifiers when coupled with the identity of the database for which they are accession numbers. Accession numbers which are used for indexing citations in a dataset of citations should NOT be entered in Citation.citedArtifact.publicationForm.accessionNumber -- this use would be a type of Citation.identifier for the citation record itself.; (xsd)accessionNumber:string>?
< Used for full display of pagination.; (xsd)pageString:string>?
< Used for isolated representation of first page.; (xsd)firstPage:string>?
< Used for isolated representation of last page.; (xsd)lastPage:string>?
< Actual or approximate number of pages or screens. Distinct from reporting the page numbers.; (xsd)pageCount:string>?
< Copyright notice for the full article or artifact. It is possible that different publication forms have different copyright notices.; (xsd)copyright:markdown>?🔗 The collection the cited article or artifact is published in.Citation.citedArtifact.publicationForm.publishedIn(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Kind of container (e.g. Periodical, database, or book). Journals and newspapers are coded as Periodical. Binding: published-in-type (extensible, ); (xsd)type:CodeableConcept>?
[]< Journal identifiers include ISSN, ISO Abbreviation and NLMuniqueID; Book identifiers include ISBN.; (xsd)identifier:Identifier>*
< Name of the database or title of the book or journal. ClinicalTrials.gov is a name of a database.; (xsd)title:string>?
< Name of or resource describing the publisher.; (xsd)publisher:Organization*>?
< Geographic location of the publisher.; (xsd)publisherLocation:string>?🔗 The artifact related to the cited artifact. The citedArtifact.relatesTo element uses a BackboneElement instead of the RelatedArtifact Datatype to enable use of an extended value set for the required code for the type of relationship.Citation.citedArtifact.relatesTo(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The type of relationship to the related artifact. Binding: related-artifact-type-all (required, ); (xsd)type:code>
[]< Provides additional classifiers of the related artifact. Binding: citation-artifact-classifier (extensible, ); (xsd)classifier:CodeableConcept>*
< A short label that can be used to reference the related artifact from elsewhere in the containing artifact, such as a footnote index. Though not commonly used in citation records, this could be used for referencing other articles in the abstract or explanatory notes.; (xsd)label:string>?
< A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.; (xsd)display:string>?
< A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format.; (xsd)citation:markdown>?
< The document being referenced, represented as an attachment. Do not use this element if using the resource element to provide the canonical to the related artifact. To refer to related artifacts by URL, the FHIR Attachment Datatype includes a url element, so the path would be Citation.citedArtifact.relatesTo.document.url; (xsd)document:Attachment>?
< The related artifact, 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; (xsd)resource:Resource*>?
< The related artifact, if the artifact is not a canonical resource, or a resource reference to a canonical resource. If both resource and resourceReference are present, they SHOULD be consistent and reference the same resource. Although relatedArtifact is intended to support references to definitional resources, there are cases where non-definitional resources can be definitional (such as Location where the kind is mode). Related artifacts SHOULD be used to reference definitional resources, and profiles SHOULD be used to make that explicit for particular use cases.; (xsd)resourceReference:Resource*>?🔗 An effective date or period, historical or future, actual or expected, for a status of the cited artifact.Citation.citedArtifact.statusDate(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A definition of the status associated with a date or period. Binding: cited-artifact-status-type (extensible, ); (xsd)activity:CodeableConcept>
< Either occurred or expected.; (xsd)actual:boolean>?
< When the status started and/or ended. For an instance, place the same value in both start and end elements.; (xsd)period:Period>🔗 The title details of the article or artifact.Citation.citedArtifact.title(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< Used to express the reason for or classification of the title. Binding: title-type (extensible, ); (xsd)type:CodeableConcept>*
< Used to express the specific language of the title. Binding: languages (preferred, A human language.); (xsd)language:CodeableConcept>?
< The title of the article or artifact.; (xsd)text:markdown>🔗 The defined version of the cited artifact.Citation.citedArtifact.version(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The version number or other version identifier.; (xsd)value:string>
< Citation for the main version of the cited artifact. When referencing a baseCitation, one may inherit any data from the referenced Citation Resource and consider any data in the current Citation Resource as superceding to be version-specific.; (xsd)baseCitation:Citation*>?🔗 Used for any URL for the article or artifact cited.Citation.citedArtifact.webLocation(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< A characterization of the object expected at the web location. Categories that may be frequently used for study citations may include abstract, full-text, supplement, webpage, and doi-based. Binding: artifact-url-classifier (extensible, ); (xsd)classifier:CodeableConcept>*
< The specific URL. Persistent URLs, like doi, are preferred.; (xsd)url:uri>?🔗 The assignment to an organizing scheme. Use this element if you need to classify the citation record independently from classifying the cited artifact.Citation.classification(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The kind of classifier (e.g. publication type, keyword). Binding: citation-classification-type (extensible, ); (xsd)type:CodeableConcept>?
[]< The specific classification value. Binding: citation-artifact-classifier (example, ); (xsd)classifier:CodeableConcept>*🔗 The state or status of the citation record paired with an effective date or period for that state. Use this if needed for reporting the state or status of the citation record, NOT FOR reporting the state or status of the cited article.Citation.statusDate(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The state or status of the citation record (that will be paired with the period). Binding: citation-status-type (example, ); (xsd)activity:CodeableConcept>
< Whether the status date is actual (has occurred) or expected (estimated or anticipated).; (xsd)actual:boolean>?
< When the status started and/or ended. For an instance, place the same value in both start and end elements.; (xsd)period:Period>🔗 A human-readable display of key concepts to represent the citation.Citation.summary(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Format for display of the citation summary. Binding: citation-summary-style (extensible, ); (xsd)style:CodeableConcept>?
< The human-readable display of the citation summary.; (xsd)text:markdown>🔗 A provider issued list of professional services and products which have been provided, or are to be provided, to a patient which is sent to an insurer for reimbursement. The Claim resource fulfills three information request requirements: Claim - a request for adjudication for reimbursement for products and/or services provided; Preauthorization - a request to authorize the future provision of products and/or services including an anticipated adjudication; and, Predetermination - a request for a non-bind adjudication of possible future products and/or services.Claim(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< A unique identifier assigned to this claim.; (xsd)identifier:Identifier>*
[]< Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners.; (xsd)traceNumber:Identifier>*
< The status of the resource instance. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. Binding: fm-status (required, A code specifying the state of the resource instance.); (xsd)status:code>
< The category of claim, e.g. oral, pharmacy, vision, institutional, professional. The code system provides oral, pharmacy, vision, professional and institutional claim types. Those supported depends on the requirements of the jurisdiction. The valueset is extensible to accommodate other types of claims as required by the jurisdiction. Binding: claim-type (extensible, The type or discipline-style of the claim.); (xsd)type:CodeableConcept>
< A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service. This may contain the local bill type codes, for example the US UB-04 bill type code or the CMS bill type. Binding: claim-subtype (example, A more granular claim typecode.); (xsd)subType:CodeableConcept>?
< A code to indicate whether the nature of the request is: Claim - A request to an Insurer to adjudicate the supplied charges for health care goods and services under the identified policy and to pay the determined Benefit amount, if any; Preauthorization - A request to an Insurer to adjudicate the supplied proposed future charges for health care goods and services under the identified policy and to approve the services and provide the expected benefit amounts and potentially to reserve funds to pay the benefits when Claims for the indicated services are later submitted; or, Pre-determination - A request to an Insurer to adjudicate the supplied 'what if' charges for health care goods and services under the identified policy and report back what the Benefit payable would be had the services actually been provided. Binding: claim-use (required, The purpose of the Claim: predetermination, preauthorization, claim.); (xsd)use:code>
< The party to whom the professional services and/or products have been supplied or are being considered and for whom actual or forecast reimbursement is sought.; (xsd)patient:Patient*>
< The period for which charges are being submitted. Typically this would be today or in the past for a claim, and today or in the future for preauthorizations and predeterminations. Typically line item dates of service should fall within the billing period if one is specified.; (xsd)billablePeriod:Period>?
< The date this resource was created. This field is independent of the date of creation of the resource as it may reflect the creation date of a source document prior to digitization. Typically for claims all services must be completed as of this date.; (xsd)created:dateTime>
< Individual who created the claim, predetermination or preauthorization.; (xsd)enterer:(<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>?
< The Insurer who is target of the request.; (xsd)insurer:Organization*>?
< The provider which is responsible for the claim, predetermination or preauthorization. Typically this field would be 1..1 where this party is accountable for the data content within the claim but is not necessarily the facility, provider group or practitioner who provided the products and services listed within this claim resource. This field is the Billing Provider, for example, a facility, provider group, lab or practitioner.; (xsd)provider:(<Organization>
|<Practitioner>
|<PractitionerRole>)>?
< The provider-required urgency of processing the request. Typical values include: stat, normal, deferred. If a claim processor is unable to complete the processing as per the priority then they should generate an error and not process the request. Binding: process-priority (example, The timeliness with which processing is required: stat, normal, deferred.); (xsd)priority:CodeableConcept>?
< A code to indicate whether and for whom funds are to be reserved for future claims. This field is only used for preauthorizations. Binding: fundsreserve (example, For whom funds are to be reserved: (Patient, Provider, None).); (xsd)fundsReserve:CodeableConcept>?
[]< Other claims which are related to this claim such as prior submissions or claims for related services or for the same event. For example, for the original treatment and follow-up exams.; (xsd)related:Claim.related>*
< Prescription is the document/authorization given to the claim author for them to provide products and services for which consideration (reimbursement) is sought. Could be a RX for medications, an 'order' for oxygen or wheelchair or physiotherapy treatments.; (xsd)prescription:(<DeviceRequest>
|<MedicationRequest>
|<VisionPrescription>)>?
< Original prescription which has been superseded by this prescription to support the dispensing of pharmacy services, medications or products. For example, a physician may prescribe a medication which the pharmacy determines is contraindicated, or for which the patient has an intolerance, and therefore issues a new prescription for an alternate medication which has the same therapeutic intent. The prescription from the pharmacy becomes the 'prescription' and that from the physician becomes the 'original prescription'.; (xsd)originalPrescription:(<DeviceRequest>
|<MedicationRequest>
|<VisionPrescription>)>?
< The party to be reimbursed for cost of the products and services according to the terms of the policy. Often providers agree to receive the benefits payable to reduce the near-term costs to the patient. The insurer may decline to pay the provider and choose to pay the subscriber instead.; (xsd)payee:Claim.payee>?
< The referral information received by the claim author, it is not to be used when the author generates a referral for a patient. A copy of that referral may be provided as supporting information. Some insurers require proof of referral to pay for services or to pay specialist rates for services. The referral resource which lists the date, practitioner, reason and other supporting information.; (xsd)referral:ServiceRequest*>?
[]< Healthcare encounters related to this claim. This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter.; (xsd)encounter:Encounter*>*
< Facility where the services were provided.; (xsd)facility:(<Location>
|<Organization>)>?
< A package billing code or bundle code used to group products and services to a particular health condition (such as heart attack) which is based on a predetermined grouping code system. For example DRG (Diagnosis Related Group) or a bundled billing code. A patient may have a diagnosis of a Myocardial Infarction and a DRG for HeartAttack would be assigned. The Claim item (and possible subsequent claims) would refer to the DRG for those line items that were for services related to the heart attack event. Binding: ex-diagnosisrelatedgroup (example, ); (xsd)diagnosisRelatedGroup:CodeableConcept>?
[]< Information code for an event with a corresponding date or period.; (xsd)event:Claim.event>*
[]< The members of the team who provided the products and services.; (xsd)careTeam:Claim.careTeam>*
[]< Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues. Often there are multiple jurisdiction specific valuesets which are required.; (xsd)supportingInfo:Claim.supportingInfo>*
[]< Information about diagnoses relevant to the claim items.; (xsd)diagnosis:Claim.diagnosis>*
[]< Procedures performed on the patient relevant to the billing items with the claim.; (xsd)procedure:Claim.procedure>*
[]< Financial instruments for reimbursement for the health care products and services specified on the claim. All insurance coverages for the patient which may be applicable for reimbursement, of the products and services listed in the claim, are typically provided in the claim to allow insurers to confirm the ordering of the insurance coverages relative to local 'coordination of benefit' rules. One coverage (and only one) with 'focal=true' is to be used in the adjudication of this claim. Coverages appearing before the focal Coverage in the list, and where 'Coverage.subrogation=false', should provide a reference to the ClaimResponse containing the adjudication results of the prior claim.; (xsd)insurance:Claim.insurance>*
< Details of an accident which resulted in injuries which required the products and services listed in the claim.; (xsd)accident:Claim.accident>?
< The amount paid by the patient, in total at the claim claim level or specifically for the item and detail level, to the provider for goods and services.; (xsd)patientPaid:Money>?
[]< A claim line. Either a simple product or service or a 'group' of details which can each be a simple items or groups of sub-details.; (xsd)item:Claim.item>*
< The total value of the all the items in the claim.; (xsd)total:Money>?🔗 Details of an accident which resulted in injuries which required the products and services listed in the claim.Claim.accident(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Date of an accident event related to the products and services contained in the claim. The date of the accident has to precede the dates of the products and services but within a reasonable timeframe.; (xsd)date>
< The type or context of the accident event for the purposes of selection of potential insurance coverages and determination of coordination between insurers. Binding: http://terminology.hl7.org/ValueSet/v3-ActIncidentCode (extensible, Type of accident: work place, auto, etc.); (xsd)type:CodeableConcept>?
< The physical location of the accident event.; (xsd)location:(<Address>
|<Location>)>?🔗 The members of the team who provided the products and services.Claim.careTeam(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A number to uniquely identify care team entries.; (xsd)sequence:positiveInt>
< Member of the team who provided the product or service.; (xsd)provider:(<Organization>
|<Practitioner>
|<PractitionerRole>)>
< The party who is billing and/or responsible for the claimed products or services. Responsible might not be required when there is only a single provider listed.; (xsd)responsible:boolean>?
< The lead, assisting or supervising practitioner and their discipline if a multidisciplinary team. Role might not be required when there is only a single provider listed. Binding: claim-careteamrole (example, The role codes for the care team members.); (xsd)role:CodeableConcept>?
< The specialization of the practitioner or provider which is applicable for this service. Binding: provider-qualification (example, ); (xsd)specialty:CodeableConcept>?🔗 Information about diagnoses relevant to the claim items.Claim.diagnosis(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A number to uniquely identify diagnosis entries. Diagnosis are presented in list order to their expected importance: primary, secondary, etc.; (xsd)sequence:positiveInt>
< The nature of illness or problem in a coded form or as a reference to an external defined Condition. Binding: icd-10 (example, Example ICD10 Diagnostic codes.); (xsd)diagnosis:(<CodeableConcept>
|<Condition>)>
[]< When the condition was observed or the relative ranking. For example: admitting, primary, secondary, discharge. Binding: ex-diagnosistype (example, The type of the diagnosis: admitting, principal, discharge.); (xsd)type:CodeableConcept>*
< Indication of whether the diagnosis was present on admission to a facility. Binding: ex-diagnosis-on-admission (example, Present on admission.); (xsd)onAdmission:CodeableConcept>?🔗 Information code for an event with a corresponding date or period.Claim.event(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A coded event such as when a service is expected or a card printed. Binding: datestype (example, ); (xsd)type:CodeableConcept>
< A date or period in the past or future indicating when the event occurred or is expectd to occur.; (xsd)when:(<dateTime>
|<Period>)>🔗 Financial instruments for reimbursement for the health care products and services specified on the claim. All insurance coverages for the patient which may be applicable for reimbursement, of the products and services listed in the claim, are typically provided in the claim to allow insurers to confirm the ordering of the insurance coverages relative to local 'coordination of benefit' rules. One coverage (and only one) with 'focal=true' is to be used in the adjudication of this claim. Coverages appearing before the focal Coverage in the list, and where 'Coverage.subrogation=false', should provide a reference to the ClaimResponse containing the adjudication results of the prior claim.Claim.insurance(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A number to uniquely identify insurance entries and provide a sequence of coverages to convey coordination of benefit order.; (xsd)sequence:positiveInt>
< A flag to indicate that this Coverage is to be used for adjudication of this claim when set to true. A patient may (will) have multiple insurance policies which provide reimbursement for healthcare services and products. For example a person may also be covered by their spouse's policy and both appear in the list (and may be from the same insurer). This flag will be set to true for only one of the listed policies and that policy will be used for adjudicating this claim. Other claims would be created to request adjudication against the other listed policies.; (xsd)focal:boolean>
< The business identifier to be used when the claim is sent for adjudication against this insurance policy. Only required in jurisdictions where insurers, rather than the provider, are required to send claims to insurers that appear after them in the list. This element is not required when 'subrogation=true'.; (xsd)identifier:Identifier>?
< Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system.; (xsd)coverage:Coverage*>
< A business agreement number established between the provider and the insurer for special business processing purposes.; (xsd)businessArrangement:string>?
[]< Reference numbers previously provided by the insurer to the provider to be quoted on subsequent claims containing services or products related to the prior authorization. This value is an alphanumeric string that may be provided over the phone, via text, via paper, or within a ClaimResponse resource and is not a FHIR Identifier.; (xsd)preAuthRef:string>*
< The result of the adjudication of the line items for the Coverage specified in this insurance. Must not be specified when 'focal=true' for this insurance.; (xsd)claimResponse:ClaimResponse*>?🔗 A claim line. Either a simple product or service or a 'group' of details which can each be a simple items or groups of sub-details.Claim.item(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A number to uniquely identify item entries.; (xsd)sequence:positiveInt>
[]< Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners.; (xsd)traceNumber:Identifier>*
[]< CareTeam members related to this service or product.; (xsd)careTeamSequence:positiveInt>*
[]< Diagnosis applicable for this service or product.; (xsd)diagnosisSequence:positiveInt>*
[]< Procedures applicable for this service or product.; (xsd)procedureSequence:positiveInt>*
[]< Exceptions, special conditions and supporting information applicable for this service or product.; (xsd)informationSequence:positiveInt>*
< The type of revenue or cost center providing the product and/or service. Binding: ex-revenue-center (example, Codes for the revenue or cost centers supplying the service and/or products.); (xsd)revenue:CodeableConcept>?
< Code to identify the general type of benefits under which products and services are provided. Examples include Medical Care, Periodontics, Renal Dialysis, Vision Coverage. Binding: ex-benefitcategory (example, Benefit categories such as: oral-basic, major, glasses.); (xsd)category:CodeableConcept>?
< When the value is a group code then this item collects a set of related item details, otherwise this contains the product, service, drug or other billing code for the item. This element may be the start of a range of .productOrService codes used in conjunction with .productOrServiceEnd or it may be a solo element where .productOrServiceEnd is not used. If this is an actual service or product line, i.e. not a Group, then use code to indicate the Professional Service or Product supplied (e.g. CTP, HCPCS, USCLS, ICD10, NCPDP, DIN, RxNorm, ACHI, CCI). If a grouping item then use a group code to indicate the type of thing being grouped e.g. 'glasses' or 'compound'. Binding: service-uscls (example, Allowable service and product codes.); (xsd)productOrService:CodeableConcept>?
< This contains the end of a range of product, service, drug or other billing codes for the item. This element is not used when the .productOrService is a group code. This value may only be present when a .productOfService code has been provided to convey the start of the range. Typically this value may be used only with preauthorizations and not with claims. Binding: service-uscls (example, ); (xsd)productOrServiceEnd:CodeableConcept>?
[]< Request or Referral for Goods or Service to be rendered.; (xsd)request:(<DeviceRequest>
|<MedicationRequest>
|<NutritionOrder>
|<ServiceRequest>
|<SupplyRequest>
|<VisionPrescription>)>*
[]< Item typification or modifiers codes to convey additional context for the product or service. For example in Oral whether the treatment is cosmetic or associated with TMJ, or for Medical whether the treatment was outside the clinic or outside of office hours. Binding: claim-modifiers (example, Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.); (xsd)modifier:CodeableConcept>*
[]< Identifies the program under which this may be recovered. For example: Neonatal program, child dental program or drug users recovery program. Binding: ex-program-code (example, Program specific reason codes.); (xsd)programCode:CodeableConcept>*
< The date or dates when the service or product was supplied, performed or completed.; (xsd)serviced:(<date>
|<Period>)>?
< Where the product or service was provided. Binding: service-place (example, Place of service: pharmacy, school, prison, etc.); (xsd)location:(<Address>
|<CodeableConcept>
|<Location>)>?
< The amount paid by the patient, in total at the claim claim level or specifically for the item and detail level, to the provider for goods and services.; (xsd)patientPaid:Money>?
< The number of repetitions of a service or product.; (xsd)quantity:SimpleQuantity>?
< If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.; (xsd)unitPrice:Money>?
< A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount. To show a 10% senior's discount, the value entered is: 0.90 (1.00 - 0.10).; (xsd)factor:decimal>?
< The total of taxes applicable for this product or service.; (xsd)tax:Money>?
< The total amount claimed for the group (if a grouper) or the line item. Net = unit price * quantity * factor. For example, the formula: quantity * unitPrice * factor = net. Quantity and factor are assumed to be 1 if not supplied.; (xsd)net:Money>?
[]< Unique Device Identifiers associated with this line item.; (xsd)udi:Device*>*
[]< Physical location where the service is performed or applies.; (xsd)bodySite:Claim.item.bodySite>*
[]< Healthcare encounters related to this claim. This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter.; (xsd)encounter:Encounter*>*
[]< A claim detail line. Either a simple (a product or service) or a 'group' of sub-details which are simple items.; (xsd)detail:Claim.item.detail>*🔗 Physical location where the service is performed or applies.Claim.item.bodySite(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< Physical service site on the patient (limb, tooth, etc.). For example: Providing a tooth code, allows an insurer to identify a provider performing a filling on a tooth that was previously removed. Binding: tooth (example, ); (xsd)site:BodyStructure*>+
[]< A region or surface of the bodySite, e.g. limb region or tooth surface(s). Binding: surface (example, ); (xsd)subSite:CodeableConcept>*🔗 A claim detail line. Either a simple (a product or service) or a 'group' of sub-details which are simple items.Claim.item.detail(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A number to uniquely identify item entries.; (xsd)sequence:positiveInt>
[]< Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners.; (xsd)traceNumber:Identifier>*
< The type of revenue or cost center providing the product and/or service. Binding: ex-revenue-center (example, Codes for the revenue or cost centers supplying the service and/or products.); (xsd)revenue:CodeableConcept>?
< Code to identify the general type of benefits under which products and services are provided. Examples include Medical Care, Periodontics, Renal Dialysis, Vision Coverage. Binding: ex-benefitcategory (example, Benefit categories such as: oral-basic, major, glasses.); (xsd)category:CodeableConcept>?
< When the value is a group code then this item collects a set of related item details, otherwise this contains the product, service, drug or other billing code for the item. This element may be the start of a range of .productOrService codes used in conjunction with .productOrServiceEnd or it may be a solo element where .productOrServiceEnd is not used. If this is an actual service or product line, i.e. not a Group, then use code to indicate the Professional Service or Product supplied (e.g. CTP, HCPCS, USCLS, ICD10, NCPDP, DIN, RxNorm, ACHI, CCI). If a grouping item then use a group code to indicate the type of thing being grouped e.g. 'glasses' or 'compound'. Binding: service-uscls (example, Allowable service and product codes.); (xsd)productOrService:CodeableConcept>?
< This contains the end of a range of product, service, drug or other billing codes for the item. This element is not used when the .productOrService is a group code. This value may only be present when a .productOfService code has been provided to convey the start of the range. Typically this value may be used only with preauthorizations and not with claims. Binding: service-uscls (example, ); (xsd)productOrServiceEnd:CodeableConcept>?
[]< Item typification or modifiers codes to convey additional context for the product or service. For example in Oral whether the treatment is cosmetic or associated with TMJ, or for Medical whether the treatment was outside the clinic or out of office hours. Binding: claim-modifiers (example, Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.); (xsd)modifier:CodeableConcept>*
[]< Identifies the program under which this may be recovered. For example: Neonatal program, child dental program or drug users recovery program. Binding: ex-program-code (example, Program specific reason codes.); (xsd)programCode:CodeableConcept>*
< The amount paid by the patient, in total at the claim claim level or specifically for the item and detail level, to the provider for goods and services.; (xsd)patientPaid:Money>?
< The number of repetitions of a service or product.; (xsd)quantity:SimpleQuantity>?
< If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.; (xsd)unitPrice:Money>?
< A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount. To show a 10% senior's discount, the value entered is: 0.90 (1.00 - 0.10).; (xsd)factor:decimal>?
< The total of taxes applicable for this product or service.; (xsd)tax:Money>?
< The total amount claimed for the group (if a grouper) or the line item.detail. Net = unit price * quantity * factor. For example, the formula: quantity * unitPrice * factor = net. Quantity and factor are assumed to be 1 if not supplied.; (xsd)net:Money>?
[]< Unique Device Identifiers associated with this line item.; (xsd)udi:Device*>*
[]< A claim detail line. Either a simple (a product or service) or a 'group' of sub-details which are simple items.; (xsd)subDetail:Claim.item.detail.subDetail>*🔗 A claim detail line. Either a simple (a product or service) or a 'group' of sub-details which are simple items.Claim.item.detail.subDetail(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A number to uniquely identify item entries.; (xsd)sequence:positiveInt>
[]< Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners.; (xsd)traceNumber:Identifier>*
< The type of revenue or cost center providing the product and/or service. Binding: ex-revenue-center (example, Codes for the revenue or cost centers supplying the service and/or products.); (xsd)revenue:CodeableConcept>?
< Code to identify the general type of benefits under which products and services are provided. Examples include Medical Care, Periodontics, Renal Dialysis, Vision Coverage. Binding: ex-benefitcategory (example, Benefit categories such as: oral-basic, major, glasses.); (xsd)category:CodeableConcept>?
< When the value is a group code then this item collects a set of related item details, otherwise this contains the product, service, drug or other billing code for the item. This element may be the start of a range of .productOrService codes used in conjunction with .productOrServiceEnd or it may be a solo element where .productOrServiceEnd is not used. If this is an actual service or product line, i.e. not a Group, then use code to indicate the Professional Service or Product supplied (e.g. CTP, HCPCS, USCLS, ICD10, NCPDP, DIN, RxNorm, ACHI, CCI). If a grouping item then use a group code to indicate the type of thing being grouped e.g. 'glasses' or 'compound'. Binding: service-uscls (example, Allowable service and product codes.); (xsd)productOrService:CodeableConcept>?
< This contains the end of a range of product, service, drug or other billing codes for the item. This element is not used when the .productOrService is a group code. This value may only be present when a .productOfService code has been provided to convey the start of the range. Typically this value may be used only with preauthorizations and not with claims. Binding: service-uscls (example, ); (xsd)productOrServiceEnd:CodeableConcept>?
[]< Item typification or modifiers codes to convey additional context for the product or service. For example in Oral whether the treatment is cosmetic or associated with TMJ, or for Medical whether the treatment was outside the clinic or out of office hours. Binding: claim-modifiers (example, Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.); (xsd)modifier:CodeableConcept>*
[]< Identifies the program under which this may be recovered. For example: Neonatal program, child dental program or drug users recovery program. Binding: ex-program-code (example, Program specific reason codes.); (xsd)programCode:CodeableConcept>*
< The amount paid by the patient, in total at the claim claim level or specifically for the item and detail level, to the provider for goods and services.; (xsd)patientPaid:Money>?
< The number of repetitions of a service or product.; (xsd)quantity:SimpleQuantity>?
< If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.; (xsd)unitPrice:Money>?
< A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount. To show a 10% senior's discount, the value entered is: 0.90 (1.00 - 0.10).; (xsd)factor:decimal>?
< The total of taxes applicable for this product or service.; (xsd)tax:Money>?
< The total amount claimed for line item.detail.subDetail. Net = unit price * quantity * factor. For example, the formula: quantity * unitPrice * factor = net. Quantity and factor are assumed to be 1 if not supplied.; (xsd)net:Money>?
[]< Unique Device Identifiers associated with this line item.; (xsd)udi:Device*>*🔗 The party to be reimbursed for cost of the products and services according to the terms of the policy. Often providers agree to receive the benefits payable to reduce the near-term costs to the patient. The insurer may decline to pay the provider and choose to pay the subscriber instead.Claim.payee(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Type of Party to be reimbursed: subscriber, provider, other. Binding: payeetype (example, A code for the party to be reimbursed.); (xsd)type:CodeableConcept>
< Reference to the individual or organization to whom any payment will be made. Not required if the payee is 'subscriber' or 'provider'.; (xsd)party:(<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>?🔗 Procedures performed on the patient relevant to the billing items with the claim.Claim.procedure(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A number to uniquely identify procedure entries.; (xsd)sequence:positiveInt>
[]< When the condition was observed or the relative ranking. For example: primary, secondary. Binding: ex-procedure-type (example, Example procedure type codes.); (xsd)type:CodeableConcept>*
< Date and optionally time the procedure was performed.; (xsd)date:dateTime>?
< The code or reference to a Procedure resource which identifies the clinical intervention performed. Binding: icd-10-procedures (example, Example ICD10 Procedure codes.); (xsd)procedure:(<CodeableConcept>
|<Procedure>)>
[]< Unique Device Identifiers associated with this line item.; (xsd)udi:Device*>*🔗 Other claims which are related to this claim such as prior submissions or claims for related services or for the same event. For example, for the original treatment and follow-up exams.Claim.related(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Reference to a related claim.; (xsd)claim:Claim*>?
< A code to convey how the claims are related. For example, prior claim or umbrella. Binding: related-claim-relationship (example, Relationship of this claim to a related Claim.); (xsd)relationship:CodeableConcept>?
< An alternate organizational reference to the case or file to which this particular claim pertains. For example, Property/Casualty insurer claim # or Workers Compensation case # .; (xsd)reference:Identifier>?🔗 Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues. Often there are multiple jurisdiction specific valuesets which are required.Claim.supportingInfo(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A number to uniquely identify supporting information entries.; (xsd)sequence:positiveInt>
< The general class of the information supplied: information; exception; accident, employment; onset, etc. This may contain a category for the local bill type codes. Binding: claim-informationcategory (example, The valuset used for additional information category codes.); (xsd)category:CodeableConcept>
< System and code pertaining to the specific information regarding special conditions relating to the setting, treatment or patient for which care is sought. Binding: claim-exception (example, The valuset used for additional information codes.); (xsd)code:CodeableConcept>?
< The date when or period to which this information refers.; (xsd)timing:(<date>
|<Period>)>?
(<valueAttachment:Attachment>
|<valueBoolean:boolean>
|<valueIdentifier:Identifier>
|<valueQuantity:Quantity>
|<valueResource:Resource>
|<valueString:string>)?
< Provides the reason in the situation where a reason code is required in addition to the content. For example: the reason for the additional stay, or why a tooth is missing. Binding: missing-tooth-reason (example, Reason codes for the missing teeth.); (xsd)reason:CodeableConcept>?🔗 This resource provides the adjudication details from the processing of a Claim resource.ClaimResponse(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< A unique identifier assigned to this claim response.; (xsd)identifier:Identifier>*
[]< Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners.; (xsd)traceNumber:Identifier>*
< The status of the resource instance. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. Binding: fm-status (required, A code specifying the state of the resource instance.); (xsd)status:code>
< A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service. This may contain the local bill type codes, for example the US UB-04 bill type code or the CMS bill type. Binding: claim-type (extensible, The type or discipline-style of the claim.); (xsd)type:CodeableConcept>
< A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service. This may contain the local bill type codes, for example the US UB-04 bill type code or the CMS bill type. Binding: claim-subtype (example, A more granular claim typecode.); (xsd)subType:CodeableConcept>?
< A code to indicate whether the nature of the request is: Claim - A request to an Insurer to adjudicate the supplied charges for health care goods and services under the identified policy and to pay the determined Benefit amount, if any; Preauthorization - A request to an Insurer to adjudicate the supplied proposed future charges for health care goods and services under the identified policy and to approve the services and provide the expected benefit amounts and potentially to reserve funds to pay the benefits when Claims for the indicated services are later submitted; or, Pre-determination - A request to an Insurer to adjudicate the supplied 'what if' charges for health care goods and services under the identified policy and report back what the Benefit payable would be had the services actually been provided. Binding: claim-use (required, Claim, preauthorization, predetermination.); (xsd)use:code>
< The party to whom the professional services and/or products have been supplied or are being considered and for whom actual for facast reimbursement is sought.; (xsd)patient:Patient*>
< The date this resource was created.; (xsd)created:dateTime>
< The party responsible for authorization, adjudication and reimbursement.; (xsd)insurer:Organization*>?
< The provider which is responsible for the claim, predetermination or preauthorization. Typically this field would be 1..1 where this party is accountable for the data content within the claim but is not necessarily the facility, provider group or practitioner who provided the products and services listed within this claim resource. This field is the Billing Provider, for example, a facility, provider group, lab or practitioner..; (xsd)requestor:(<Organization>
|<Practitioner>
|<PractitionerRole>)>?
< Original request resource reference.; (xsd)request:Claim*>?
< The outcome of the claim, predetermination, or preauthorization processing. The resource may be used to indicate that the Claim/Preauthorization/Pre-determination has been received but processing has not begun (queued); that it has been processed and one or more errors have been detected (error); no errors were detected and some of the adjudication processing has been performed (partial); or all of the adjudication processing has completed without errors (complete). Binding: claim-outcome (required, The result of the claim processing.); (xsd)outcome:code>
< The result of the claim, predetermination, or preauthorization adjudication. The element is used to indicate the current state of the adjudication overall for the claim resource, for example: the request has been held (pended) for adjudication processing, for manual review or other reasons; that it has been processed and will be paid, or the outstanding paid, as submitted (approved); that no amount will be paid (denied); or that some amount between zero and the submitted amount will be paid (partial). Binding: claim-decision (example, The overall result of the claim adjudication.); (xsd)decision:CodeableConcept>?
< A human readable description of the status of the adjudication.; (xsd)disposition:string>?
< Reference from the Insurer which is used in later communications which refers to this adjudication. This value is only present on preauthorization adjudications.; (xsd)preAuthRef:string>?
< The time frame during which this authorization is effective.; (xsd)preAuthPeriod:Period>?
[]< Information code for an event with a corresponding date or period.; (xsd)event:ClaimResponse.event>*
< Type of Party to be reimbursed: subscriber, provider, other. Binding: payeetype (example, A code for the party to be reimbursed.); (xsd)payeeType:CodeableConcept>?
[]< Healthcare encounters related to this claim. This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter.; (xsd)encounter:Encounter*>*
< A package billing code or bundle code used to group products and services to a particular health condition (such as heart attack) which is based on a predetermined grouping code system. For example DRG (Diagnosis Related Group) or a bundled billing code. A patient may have a diagnosis of a Myocardial Infarction and a DRG for HeartAttack would be assigned. The Claim item (and possible subsequent claims) would refer to the DRG for those line items that were for services related to the heart attack event. Binding: ex-diagnosisrelatedgroup (example, ); (xsd)diagnosisRelatedGroup:CodeableConcept>?
[]< A claim line. Either a simple (a product or service) or a 'group' of details which can also be a simple items or groups of sub-details.; (xsd)item:ClaimResponse.item>*
[]< The first-tier service adjudications for payor added product or service lines.; (xsd)addItem:ClaimResponse.addItem>*
[]< The adjudication results which are presented at the header level rather than at the line-item or add-item levels.; (xsd)adjudication:ClaimResponse.item.adjudication>*
[]< Categorized monetary totals for the adjudication. Totals for amounts submitted, co-pays, benefits payable etc.; (xsd)total:ClaimResponse.total>*
< Payment details for the adjudication of the claim.; (xsd)payment:ClaimResponse.payment>?
< A code, used only on a response to a preauthorization, to indicate whether the benefits payable have been reserved and for whom. Fund would be release by a future claim quoting the preAuthRef of this response. Examples of values include: provider, patient, none. Binding: fundsreserve (example, For whom funds are to be reserved: (Patient, Provider, None).); (xsd)fundsReserve:CodeableConcept>?
< A code for the form to be used for printing the content. May be needed to identify specific jurisdictional forms. Binding: forms (example, The forms codes.); (xsd)formCode:CodeableConcept>?
< The actual form, by reference or inclusion, for printing the content or an EOB. Needed to permit insurers to include the actual form.; (xsd)form:Attachment>?
[]< A note that describes or explains adjudication results in a human readable form.; (xsd)processNote:ClaimResponse.processNote>*
[]< Request for additional supporting or authorizing information. For example: professional reports, documents, images, clinical resources, or accident reports.; (xsd)communicationRequest:CommunicationRequest*>*
[]< Financial instruments for reimbursement for the health care products and services specified on the claim. All insurance coverages for the patient which may be applicable for reimbursement, of the products and services listed in the claim, are typically provided in the claim to allow insurers to confirm the ordering of the insurance coverages relative to local 'coordination of benefit' rules. One coverage (and only one) with 'focal=true' is to be used in the adjudication of this claim. Coverages appearing before the focal Coverage in the list, and where 'subrogation=false', should provide a reference to the ClaimResponse containing the adjudication results of the prior claim.; (xsd)insurance:ClaimResponse.insurance>*
[]< Errors encountered during the processing of the adjudication. If the request contains errors then an error element should be provided and no adjudication related sections (item, addItem, or payment) should be present.; (xsd)error:ClaimResponse.error>*🔗 The first-tier service adjudications for payor added product or service lines.ClaimResponse.addItem(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< Claim items which this service line is intended to replace.; (xsd)itemSequence:positiveInt>*
[]< The sequence number of the details within the claim item which this line is intended to replace.; (xsd)detailSequence:positiveInt>*
[]< The sequence number of the sub-details within the details within the claim item which this line is intended to replace.; (xsd)subdetailSequence:positiveInt>*
[]< Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners.; (xsd)traceNumber:Identifier>*
[]< The providers who are authorized for the services rendered to the patient.; (xsd)provider:(<Organization>
|<Practitioner>
|<PractitionerRole>)>*
< The type of revenue or cost center providing the product and/or service. Binding: ex-revenue-center (example, Codes for the revenue or cost centers supplying the service and/or products.); (xsd)revenue:CodeableConcept>?
< When the value is a group code then this item collects a set of related item details, otherwise this contains the product, service, drug or other billing code for the item. This element may be the start of a range of .productOrService codes used in conjunction with .productOrServiceEnd or it may be a solo element where .productOrServiceEnd is not used. If this is an actual service or product line, i.e. not a Group, then use code to indicate the Professional Service or Product supplied (e.g. CTP, HCPCS, USCLS, ICD10, NCPDP, DIN, RxNorm, ACHI, CCI). If a grouping item then use a group code to indicate the type of thing being grouped e.g. 'glasses' or 'compound'. Binding: service-uscls (example, Allowable service and product codes.); (xsd)productOrService:CodeableConcept>?
< This contains the end of a range of product, service, drug or other billing codes for the item. This element is not used when the .productOrService is a group code. This value may only be present when a .productOfService code has been provided to convey the start of the range. Typically this value may be used only with preauthorizations and not with claims. Binding: service-uscls (example, ); (xsd)productOrServiceEnd:CodeableConcept>?
[]< Request or Referral for Goods or Service to be rendered.; (xsd)request:(<DeviceRequest>
|<MedicationRequest>
|<NutritionOrder>
|<ServiceRequest>
|<SupplyRequest>
|<VisionPrescription>)>*
[]< Item typification or modifiers codes to convey additional context for the product or service. For example in Oral whether the treatment is cosmetic or associated with TMJ, or for Medical whether the treatment was outside the clinic or outside of office hours. Binding: claim-modifiers (example, Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.); (xsd)modifier:CodeableConcept>*
[]< Identifies the program under which this may be recovered. For example: Neonatal program, child dental program or drug users recovery program. Binding: ex-program-code (example, Program specific reason codes.); (xsd)programCode:CodeableConcept>*
< The date or dates when the service or product was supplied, performed or completed.; (xsd)serviced:(<date>
|<Period>)>?
< Where the product or service was provided. Binding: service-place (example, Place of service: pharmacy, school, prison, etc.); (xsd)location:(<Address>
|<CodeableConcept>
|<Location>)>?
< The number of repetitions of a service or product.; (xsd)quantity:SimpleQuantity>?
< If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.; (xsd)unitPrice:Money>?
< A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount. To show a 10% senior's discount, the value entered is: 0.90 (1.00 - 0.10).; (xsd)factor:decimal>?
< The total of taxes applicable for this product or service.; (xsd)tax:Money>?
< The total amount claimed for the group (if a grouper) or the addItem. Net = unit price * quantity * factor. For example, the formula: quantity * unitPrice * factor = net. Quantity and factor are assumed to be 1 if not supplied.; (xsd)net:Money>?
[]< Physical location where the service is performed or applies.; (xsd)bodySite:ClaimResponse.addItem.bodySite>*
[]< The numbers associated with notes below which apply to the adjudication of this item.; (xsd)noteNumber:positiveInt>*
< The high-level results of the adjudication if adjudication has been performed.; (xsd)reviewOutcome:ClaimResponse.item.reviewOutcome>?
[]< The adjudication results.; (xsd)adjudication:ClaimResponse.item.adjudication>*
[]< The second-tier service adjudications for payor added services.; (xsd)detail:ClaimResponse.addItem.detail>*🔗 Physical location where the service is performed or applies.ClaimResponse.addItem.bodySite(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< Physical service site on the patient (limb, tooth, etc.). For example: Providing a tooth code allows an insurer to identify a provider performing a filling on a tooth that was previously removed. Binding: tooth (example, ); (xsd)site:BodyStructure*>+
[]< A region or surface of the bodySite, e.g. limb region or tooth surface(s). Binding: surface (example, ); (xsd)subSite:CodeableConcept>*🔗 The second-tier service adjudications for payor added services.ClaimResponse.addItem.detail(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners.; (xsd)traceNumber:Identifier>*
< The type of revenue or cost center providing the product and/or service. Binding: ex-revenue-center (example, Codes for the revenue or cost centers supplying the service and/or products.); (xsd)revenue:CodeableConcept>?
< When the value is a group code then this item collects a set of related item details, otherwise this contains the product, service, drug or other billing code for the item. This element may be the start of a range of .productOrService codes used in conjunction with .productOrServiceEnd or it may be a solo element where .productOrServiceEnd is not used. If this is an actual service or product line, i.e. not a Group, then use code to indicate the Professional Service or Product supplied (e.g. CTP, HCPCS, USCLS, ICD10, NCPDP, DIN, RxNorm, ACHI, CCI). If a grouping item then use a group code to indicate the type of thing being grouped e.g. 'glasses' or 'compound'. Binding: service-uscls (example, Allowable service and product codes.); (xsd)productOrService:CodeableConcept>?
< This contains the end of a range of product, service, drug or other billing codes for the item. This element is not used when the .productOrService is a group code. This value may only be present when a .productOfService code has been provided to convey the start of the range. Typically this value may be used only with preauthorizations and not with claims. Binding: service-uscls (example, ); (xsd)productOrServiceEnd:CodeableConcept>?
[]< Item typification or modifiers codes to convey additional context for the product or service. For example in Oral whether the treatment is cosmetic or associated with TMJ, or for Medical whether the treatment was outside the clinic or outside of office hours. Binding: claim-modifiers (example, Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.); (xsd)modifier:CodeableConcept>*
< The number of repetitions of a service or product.; (xsd)quantity:SimpleQuantity>?
< If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.; (xsd)unitPrice:Money>?
< A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount. To show a 10% senior's discount, the value entered is: 0.90 (1.00 - 0.10).; (xsd)factor:decimal>?
< The total of taxes applicable for this product or service.; (xsd)tax:Money>?
< The total amount claimed for the group (if a grouper) or the addItem.detail. Net = unit price * quantity * factor. For example, the formula: quantity * unitPrice * factor = net. Quantity and factor are assumed to be 1 if not supplied.; (xsd)net:Money>?
[]< The numbers associated with notes below which apply to the adjudication of this item.; (xsd)noteNumber:positiveInt>*
< The high-level results of the adjudication if adjudication has been performed.; (xsd)reviewOutcome:ClaimResponse.item.reviewOutcome>?
[]< The adjudication results.; (xsd)adjudication:ClaimResponse.item.adjudication>*
[]< The third-tier service adjudications for payor added services.; (xsd)subDetail:ClaimResponse.addItem.detail.subDetail>*🔗 The third-tier service adjudications for payor added services.ClaimResponse.addItem.detail.subDetail(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners.; (xsd)traceNumber:Identifier>*
< The type of revenue or cost center providing the product and/or service. Binding: ex-revenue-center (example, Codes for the revenue or cost centers supplying the service and/or products.); (xsd)revenue:CodeableConcept>?
< When the value is a group code then this item collects a set of related item details, otherwise this contains the product, service, drug or other billing code for the item. This element may be the start of a range of .productOrService codes used in conjunction with .productOrServiceEnd or it may be a solo element where .productOrServiceEnd is not used. If this is an actual service or product line, i.e. not a Group, then use code to indicate the Professional Service or Product supplied (e.g. CTP, HCPCS, USCLS, ICD10, NCPDP, DIN, RxNorm, ACHI, CCI). If a grouping item then use a group code to indicate the type of thing being grouped e.g. 'glasses' or 'compound'. Binding: service-uscls (example, Allowable service and product codes.); (xsd)productOrService:CodeableConcept>?
< This contains the end of a range of product, service, drug or other billing codes for the item. This element is not used when the .productOrService is a group code. This value may only be present when a .productOfService code has been provided to convey the start of the range. Typically this value may be used only with preauthorizations and not with claims. Binding: service-uscls (example, ); (xsd)productOrServiceEnd:CodeableConcept>?
[]< Item typification or modifiers codes to convey additional context for the product or service. For example in Oral whether the treatment is cosmetic or associated with TMJ, or for Medical whether the treatment was outside the clinic or outside of office hours. Binding: claim-modifiers (example, Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.); (xsd)modifier:CodeableConcept>*
< The number of repetitions of a service or product.; (xsd)quantity:SimpleQuantity>?
< If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.; (xsd)unitPrice:Money>?
< A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount. To show a 10% senior's discount, the value entered is: 0.90 (1.00 - 0.10).; (xsd)factor:decimal>?
< The total of taxes applicable for this product or service.; (xsd)tax:Money>?
< The total amount claimed for the addItem.detail.subDetail. Net = unit price * quantity * factor. For example, the formula: quantity * unitPrice * factor = net. Quantity and factor are assumed to be 1 if not supplied.; (xsd)net:Money>?
[]< The numbers associated with notes below which apply to the adjudication of this item.; (xsd)noteNumber:positiveInt>*
< The high-level results of the adjudication if adjudication has been performed.; (xsd)reviewOutcome:ClaimResponse.item.reviewOutcome>?
[]< The adjudication results.; (xsd)adjudication:ClaimResponse.item.adjudication>*🔗 Errors encountered during the processing of the adjudication. If the request contains errors then an error element should be provided and no adjudication related sections (item, addItem, or payment) should be present.ClaimResponse.error(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The sequence number of the line item submitted which contains the error. This value is omitted when the error occurs outside of the item structure.; (xsd)itemSequence:positiveInt>?
< The sequence number of the detail within the line item submitted which contains the error. This value is omitted when the error occurs outside of the item structure.; (xsd)detailSequence:positiveInt>?
< The sequence number of the sub-detail within the detail within the line item submitted which contains the error. This value is omitted when the error occurs outside of the item structure.; (xsd)subDetailSequence:positiveInt>?
< An error code, from a specified code system, which details why the claim could not be adjudicated. Binding: adjudication-error (example, The adjudication error codes.); (xsd)code:CodeableConcept>
[]< A [simple subset of FHIRPath](fhirpath.html#simple) limited to element names, repetition indicators and the default child accessor that identifies one of the elements in the resource that caused this issue to be raised. The root of the FHIRPath is the resource or bundle that generated OperationOutcome. Each FHIRPath SHALL resolve to a single node.; (xsd)expression:string>*🔗 Information code for an event with a corresponding date or period.ClaimResponse.event(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A coded event such as when a service is expected or a card printed. Binding: datestype (example, ); (xsd)type:CodeableConcept>
< A date or period in the past or future indicating when the event occurred or is expectd to occur.; (xsd)when:(<dateTime>
|<Period>)>🔗 Financial instruments for reimbursement for the health care products and services specified on the claim. All insurance coverages for the patient which may be applicable for reimbursement, of the products and services listed in the claim, are typically provided in the claim to allow insurers to confirm the ordering of the insurance coverages relative to local 'coordination of benefit' rules. One coverage (and only one) with 'focal=true' is to be used in the adjudication of this claim. Coverages appearing before the focal Coverage in the list, and where 'subrogation=false', should provide a reference to the ClaimResponse containing the adjudication results of the prior claim.ClaimResponse.insurance(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A number to uniquely identify insurance entries and provide a sequence of coverages to convey coordination of benefit order.; (xsd)sequence:positiveInt>
< A flag to indicate that this Coverage is to be used for adjudication of this claim when set to true. A patient may (will) have multiple insurance policies which provide reimbursement for healthcare services and products. For example a person may also be covered by their spouse's policy and both appear in the list (and may be from the same insurer). This flag will be set to true for only one of the listed policies and that policy will be used for adjudicating this claim. Other claims would be created to request adjudication against the other listed policies.; (xsd)focal:boolean>
< Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system.; (xsd)coverage:Coverage*>
< A business agreement number established between the provider and the insurer for special business processing purposes.; (xsd)businessArrangement:string>?
< The result of the adjudication of the line items for the Coverage specified in this insurance. Must not be specified when 'focal=true' for this insurance.; (xsd)claimResponse:ClaimResponse*>?🔗 A claim line. Either a simple (a product or service) or a 'group' of details which can also be a simple items or groups of sub-details.ClaimResponse.item(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A number to uniquely reference the claim item entries.; (xsd)itemSequence:positiveInt>
[]< Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners.; (xsd)traceNumber:Identifier>*
[]< The numbers associated with notes below which apply to the adjudication of this item.; (xsd)noteNumber:positiveInt>*
< The high-level results of the adjudication if adjudication has been performed.; (xsd)reviewOutcome:ClaimResponse.item.reviewOutcome>?
[]< If this item is a group then the values here are a summary of the adjudication of the detail items. If this item is a simple product or service then this is the result of the adjudication of this item.; (xsd)adjudication:ClaimResponse.item.adjudication>*
[]< A claim detail. Either a simple (a product or service) or a 'group' of sub-details which are simple items.; (xsd)detail:ClaimResponse.item.detail>*🔗 If this item is a group then the values here are a summary of the adjudication of the detail items. If this item is a simple product or service then this is the result of the adjudication of this item.ClaimResponse.item.adjudication(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A code to indicate the information type of this adjudication record. Information types may include the value submitted, maximum values or percentages allowed or payable under the plan, amounts that: the patient is responsible for in aggregate or pertaining to this item; amounts paid by other coverages; and, the benefit payable for this item. For example codes indicating: Co-Pay, deductible, eligible, benefit, tax, etc. Binding: adjudication (example, The adjudication codes.); (xsd)category:CodeableConcept>
< A code supporting the understanding of the adjudication result and explaining variance from expected amount. For example may indicate that the funds for this benefit type have been exhausted. Binding: adjudication-reason (example, The adjudication reason codes.); (xsd)reason:CodeableConcept>?
< Monetary amount associated with the category. For example: amount submitted, eligible amount, co-payment, and benefit payable.; (xsd)amount:Money>?
< A non-monetary value associated with the category. Mutually exclusive to the amount element above. For example: eligible percentage or co-payment percentage.; (xsd)quantity:Quantity>?🔗 A claim detail. Either a simple (a product or service) or a 'group' of sub-details which are simple items.ClaimResponse.item.detail(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A number to uniquely reference the claim detail entry.; (xsd)detailSequence:positiveInt>
[]< Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners.; (xsd)traceNumber:Identifier>*
[]< The numbers associated with notes below which apply to the adjudication of this item.; (xsd)noteNumber:positiveInt>*
< The high-level results of the adjudication if adjudication has been performed.; (xsd)reviewOutcome:ClaimResponse.item.reviewOutcome>?
[]< The adjudication results.; (xsd)adjudication:ClaimResponse.item.adjudication>*
[]< A sub-detail adjudication of a simple product or service.; (xsd)subDetail:ClaimResponse.item.detail.subDetail>*🔗 A sub-detail adjudication of a simple product or service.ClaimResponse.item.detail.subDetail(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A number to uniquely reference the claim sub-detail entry.; (xsd)subDetailSequence:positiveInt>
[]< Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners.; (xsd)traceNumber:Identifier>*
[]< The numbers associated with notes below which apply to the adjudication of this item.; (xsd)noteNumber:positiveInt>*
< The high-level results of the adjudication if adjudication has been performed.; (xsd)reviewOutcome:ClaimResponse.item.reviewOutcome>?
[]< The adjudication results.; (xsd)adjudication:ClaimResponse.item.adjudication>*🔗 The high-level results of the adjudication if adjudication has been performed.ClaimResponse.item.reviewOutcome(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The result of the claim, predetermination, or preauthorization adjudication. The element is used to indicate the current state of the adjudication overall for the claim resource, for example: the request has been held (pended) for adjudication processing, for manual review or other reasons; that it has been processed and will be paid, or the outstanding paid, as submitted (approved); that no amount will be paid (denied); or that some amount between zero and the submitted amount will be paid (partial). Binding: claim-decision (example, ); (xsd)decision:CodeableConcept>?
[]< The reasons for the result of the claim, predetermination, or preauthorization adjudication. Binding: claim-decision-reason (example, ); (xsd)reason:CodeableConcept>*
< Reference from the Insurer which is used in later communications which refers to this adjudication. This value is only present on preauthorization adjudications.; (xsd)preAuthRef:string>?
< The time frame during which this authorization is effective.; (xsd)preAuthPeriod:Period>?🔗 Payment details for the adjudication of the claim.ClaimResponse.payment(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Whether this represents partial or complete payment of the benefits payable. Binding: ex-paymenttype (example, The type (partial, complete) of the payment.); (xsd)type:CodeableConcept>
< Total amount of all adjustments to this payment included in this transaction which are not related to this claim's adjudication. Insurers will deduct amounts owing from the provider (adjustment), such as a prior overpayment, from the amount owing to the provider (benefits payable) when payment is made to the provider.; (xsd)adjustment:Money>?
< Reason for the payment adjustment. Binding: payment-adjustment-reason (example, Payment Adjustment reason codes.); (xsd)adjustmentReason:CodeableConcept>?
< Estimated date the payment will be issued or the actual issue date of payment.; (xsd)date>?
< Benefits payable less any payment adjustment.; (xsd)amount:Money>
< Issuer's unique identifier for the payment instrument. For example: EFT number or check number.; (xsd)identifier:Identifier>?🔗 A note that describes or explains adjudication results in a human readable form.ClaimResponse.processNote(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A number to uniquely identify a note entry.; (xsd)number:positiveInt>?
< The business purpose of the note text. Binding: note-type (extensible, The presentation types of notes.); (xsd)type:CodeableConcept>?
< The explanation or description associated with the processing.; (xsd)text:string>
< A code to define the language used in the text of the note. Only required if the language is different from the resource language. Binding: all-languages (required, IETF language tag for a human language); (xsd)language:CodeableConcept>?🔗 Categorized monetary totals for the adjudication. Totals for amounts submitted, co-pays, benefits payable etc.ClaimResponse.total(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A code to indicate the information type of this adjudication record. Information types may include: the value submitted, maximum values or percentages allowed or payable under the plan, amounts that the patient is responsible for in aggregate or pertaining to this item, amounts paid by other coverages, and the benefit payable for this item. For example codes indicating: Co-Pay, deductible, eligible, benefit, tax, etc. Binding: adjudication (example, The adjudication codes.); (xsd)category:CodeableConcept>
< Monetary total amount associated with the category.; (xsd)amount:Money>🔗 A set of healthcare-related information that is assembled together into a single logical package that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. A Composition defines the structure and narrative content necessary for a document. However, a Composition alone does not constitute a document. Rather, the Composition must be the first entry in a Bundle where Bundle.type=document, and any other resources referenced from Composition must be included as subsequent entries in the Bundle (for example Patient, Practitioner, Encounter, etc.). While the focus of this specification is on patient-specific clinical statements, this resource can also apply to other healthcare-related statements such as study protocol designs, healthcare invoices and other activities that are not necessarily patient-specific or clinical.clinicaldocument(xsd)(doc)=
<#base:Composition>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< An absolute URI that is used to identify this Composition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this Composition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the Composition is stored on different servers. Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.; (xsd)url:uri>?
[]< A version-independent identifier for the Composition. This identifier stays constant as the composition is changed over time. Similar to ClinicalDocument/setId in CDA. See discussion in resource definition for how these relate.; (xsd)identifier:Identifier>*
< An explicitly assigned identifer of a variation of the content in the Composition. While each resource, including the composition itself, has its own version identifier, this is a formal identifier for the logical version of the Composition as a whole. It would remain constant if the resources were moved to a new server, and all got new individual resource versions, for example.; (xsd)version:string>?
< The workflow/clinical status of this composition. The status is a marker for the clinical standing of the document. If a composition is marked as withdrawn, the compositions/documents in the series, or data from the composition or document series, should never be displayed to a user without being clearly marked as untrustworthy. The flag "entered-in-error" is why this element is labeled as a modifier of other elements.
Some reporting work flows require that the original narrative of a final document never be altered; instead, only new narrative can be added. The composition resource has no explicit status for explicitly noting whether this business rule is in effect. This would be handled by an extension if required. Binding: composition-status (required, The workflow/clinical status of the composition.); (xsd)status:code>
< Specifies the particular kind of composition (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the composition. For Composition type, LOINC is ubiquitous and strongly endorsed by HL7. Most implementation guides will require a specific LOINC code, or use LOINC as an extensible binding. Binding: doc-typecodes (preferred, Type of a composition.); (xsd)type:CodeableConcept>
[]< A categorization for the type of the composition - helps for indexing and searching. This may be implied by or derived from the code specified in the Composition Type. Binding: referenced-item-category (example, High-level kind of a clinical document at a macro level.); (xsd)category:CodeableConcept>*
[]< Who or what the composition is about. The composition can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of livestock, or a set of patients that share a common exposure). For clinical documents, this is usually the patient.; (xsd)subject:(<Device>
|<Group>
|<Location>
|<Patient>
|<Practitioner>)>*
< Describes the clinical encounter or type of care this documentation is associated with.; (xsd)encounter:Encounter*>?
< The composition editing time, when the composition was last logically changed by the author. The Last Modified Date on the composition may be after the date of the document was attested without being changed. This means that the date on an amended document is the date of the amendment, not the date of original authorship.; (xsd)date:dateTime>
[]< The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate Composition instances. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.; (xsd)useContext:UsageContext>*
[]< Identifies who is responsible for the information in the composition, not necessarily who typed it in.; (xsd)author:(<Device>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>+
< A natural language name identifying the {{title}}. This name should be usable as an identifier for the module by machine processing applications such as code generation. The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.; (xsd)name:string>?
< Official human-readable label for the composition. For many compositions, the title is the same as the text or a display name of Composition.type (e.g. a "consultation" or "progress note"). Note that CDA does not make title mandatory, but there are no known cases where it is useful for title to be omitted, so it is mandatory here. Feedback on this requirement is welcome during the trial use period.; (xsd)title:string>
[]< For any additional notes. A comment, general note or annotation not coded elsewhere.; (xsd)note:Annotation>*
[]< A participant who has attested to the accuracy of the composition/document. Only list each attester once.; (xsd)attester:clinicaldocument.attester>*
< Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information. This is useful when documents are derived from a composition - provides guidance for how to get the latest version of the document. This is optional because this is sometimes not known by the authoring system, and can be inferred by context. However, it is important that this information be known when working with a derived document, so providing a custodian is encouraged.; (xsd)custodian:Organization*>?
[]< Relationships that this composition has with other compositions or documents that already exist. To reference (using relatesTo) a Bundle of type "document" or another Composition where you only have the identifier, use a resourceReference with an identifier.\
When a Composition is an alternate representation of another type of document e.g. CDA, the other document could be referenced in a DocumentReference resource.
Here is an example of using relatesTo to reference another Bundle of type "document" or Composition where you only have the identifier:
```
"relatesTo": [{
"type": "replaces",
"resourceReference": {
"identifier": {
"system": "...",
"value": "..."
}
}
}]
```; (xsd)relatesTo:RelatedArtifact>*
[]< The clinical service, such as a colonoscopy or an appendectomy, being documented. The event needs to be consistent with the type element, though can provide further information if desired.; (xsd)event:clinicaldocument.event>*
[]< The root of the sections that make up the composition.; (xsd)section:clinicaldocument.section>*🔗 A participant who has attested to the accuracy of the composition/document. Only list each attester once.clinicaldocument.attester(xsd)(doc)=
<#base:Composition.attester>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The type of attestation the authenticator offers. Binding: composition-attestation-mode (preferred, The way in which a person authenticated a composition.); (xsd)mode:CodeableConcept>
< When the composition was attested by the party.; (xsd)time:dateTime>?
< Who attested the composition in the specified way.; (xsd)party:(<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>?🔗 The clinical service, such as a colonoscopy or an appendectomy, being documented. The event needs to be consistent with the type element, though can provide further information if desired.clinicaldocument.event(xsd)(doc)=
<#base:Composition.event>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The period of time covered by the documentation. There is no assertion that the documentation is a complete representation for this period, only that it documents events during this time.; (xsd)period:Period>?
[]< Represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the typeCode, such as a "History and Physical Report" in which case the procedure being documented is necessarily a "History and Physical" act. The events may be included as a code or as a reference to an other resource. An event can further specialize the act inherent in the typeCode, such as where it is simply "Procedure Report" and the procedure was a "colonoscopy". If one or more events are included, they SHALL NOT conflict with the values inherent in the classCode, practiceSettingCode or typeCode, as such a conflict would create an ambiguous situation. This short list of codes is provided to be used as key words for certain types of queries. Binding: http://terminology.hl7.org/ValueSet/v3-ActCode (example, This list of codes represents the main clinical acts being documented.); (xsd)detail:Resource*>*🔗 The root of the sections that make up the composition.clinicaldocument.section(xsd)(doc)=
<#base:Composition.section>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents. The title identifies the section for a human reader. The title must be consistent with the narrative of the resource that is the target of the section.content reference. Generally, sections SHOULD have titles, but in some documents, it is unnecessary or inappropriate. Typically, this is where a section has subsections that have their own adequately distinguishing title, or documents that only have a single section. Most Implementation Guides will make section title to be a required element.; (xsd)title:string>?
< A code identifying the kind of content contained within the section. This must be consistent with the section title. The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document.
If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code. Binding: doc-section-codes (example, Classification of a section of a composition/document.); (xsd)code:CodeableConcept>?
[]< Identifies who is responsible for the information in this section, not necessarily who typed it in.; (xsd)author:(<Device>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>*
< The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources). Typically, sections in a doument are about the subject of the document, whether that is a patient, or group of patients, location, or device, or whatever. For some kind of documents, some sections actually contain data about related entities. Typical examples are a section in a newborn discharge summary concerning the mother, or family history documents, with a section about each family member, though there are many other examples.; (xsd)focus:Resource*>?
< A human-readable narrative that contains the attested content of the section, 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. Document profiles may define what content should be represented in the narrative to ensure clinical safety.; (xsd)text:Narrative>?
< Specifies the order applied to the items in the section entries. Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order. Binding: list-order (preferred, What order applies to the items in the entry.); (xsd)orderedBy:CodeableConcept>?
[]< A reference to the actual resource from which the narrative in the section is derived. If there are no entries in the list, an emptyReason SHOULD be provided.; (xsd)entry:Resource*>*
< If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason. The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases. Binding: list-empty-reason (preferred, If a section is empty, why it is empty.); (xsd)emptyReason:CodeableConcept>?
[]< A nested sub-section within this section. Nested sections are primarily used to help human readers navigate to particular portions of the document.; (xsd)section:Composition.section>*🔗 A record of a clinical assessment performed to determine what problem(s) may affect the patient and before planning the treatments or management strategies that are best to manage a patient's condition. Assessments are often 1:1 with a clinical consultation / encounter, but this varies greatly depending on the clinical workflow. This resource is called "ClinicalImpression" rather than "ClinicalAssessment" to avoid confusion with the recording of assessment tools such as Apgar score.ClinicalImpression(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< Business identifiers assigned to this clinical impression by the performer or other systems which remain constant as the resource is updated and propagates from server to server. This is a business identifier, not a resource identifier (see [discussion](resource.html#identifiers)). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.; (xsd)identifier:Identifier>*
< Identifies the workflow status of the assessment. This element is labeled as a modifier because the status contains the code entered-in-error that marks the clinical impression as not currently valid. Binding: event-status (required, The workflow state of a clinical impression.); (xsd)status:code>
< Captures the reason for the current state of the ClinicalImpression. This is generally only used for "exception" statuses such as "not-done", "on-hold" or "stopped". Binding: clinicalimpression-status-reason (example, Codes identifying the reason for the current state of a clinical impression.); (xsd)statusReason:CodeableConcept>?
< A summary of the context and/or cause of the assessment - why / where it was performed, and what patient events/status prompted it.; (xsd)description:string>?
< The patient or group of individuals assessed as part of this record.; (xsd)subject:(<Group>
|<Patient>)>
< The Encounter during which this ClinicalImpression was created or to which the creation of this record is tightly associated. This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter.; (xsd)encounter:Encounter*>?
< The point in time or period over which the subject was assessed. This SHOULD be accurate to at least the minute, though some assessments only have a known date.; (xsd)effective:(<dateTime>
|<Period>)>?
< Indicates when the documentation of the assessment was complete.; (xsd)date:dateTime>?
< The clinician performing the assessment.; (xsd)performer:(<Practitioner>
|<PractitionerRole>)>?
< A reference to the last assessment that was conducted on this patient. Assessments are often/usually ongoing in nature; a care provider (practitioner or team) will make new assessments on an ongoing basis as new data arises or the patient's conditions changes. It is always likely that multiple previous assessments exist for a patient. The point of quoting a previous assessment is that this assessment is relative to it (see resolved).; (xsd)previous:ClinicalImpression*>?
[]< A list of the relevant problems/conditions for a patient. e.g. The patient is a pregnant, has congestive heart failure, has an Adenocarcinoma, and is allergic to penicillin.; (xsd)problem:(<AllergyIntolerance>
|<Condition>)>*
< Change in the status/pattern of a subject's condition since previously assessed, such as worsening, improving, or no change. It is a subjective assessment of the direction of the change. Binding: clinicalimpression-change-pattern (example, ); (xsd)changePattern:CodeableConcept>?
[]< Reference to a specific published clinical protocol that was followed during this assessment, and/or that provides evidence in support of the diagnosis.; (xsd)protocol:uri>*
< A text summary of the investigations and the diagnosis.; (xsd)summary:string>?
[]< Specific findings or diagnoses that were considered likely or relevant to ongoing treatment.; (xsd)finding:ClinicalImpression.finding>*
[]< Estimate of likely outcome. Binding: clinicalimpression-prognosis (example, Prognosis or outlook findings.); (xsd)prognosisCodeableConcept:CodeableConcept>*
[]< RiskAssessment expressing likely outcome.; (xsd)prognosisReference:RiskAssessment*>*
[]< Information supporting the clinical impression, which can contain investigation results.; (xsd)supportingInfo:Resource*>*
[]< Commentary about the impression, typically recorded after the impression itself was made, though supplemental notes by the original author could also appear. Don't use this element for content that should more properly appear as one of the specific elements of the impression.; (xsd)note:Annotation>*🔗 Specific findings or diagnoses that were considered likely or relevant to ongoing treatment.ClinicalImpression.finding(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Specific text, code or reference for finding or diagnosis, which may include ruled-out or resolved conditions. Binding: condition-code (example, Identification of the Condition or diagnosis.); (xsd)item:(<Condition>
|<DocumentReference>
|<Observation>)>?
< Which investigations support finding or diagnosis.; (xsd)basis:string>?🔗 A single issue - either an indication, contraindication, interaction or an undesirable effect for a medicinal product, medication, device or procedure.ClinicalUseDefinition(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< Business identifier for this issue.; (xsd)identifier:Identifier>*
< indication | contraindication | interaction | undesirable-effect | warning. Binding: clinical-use-definition-type (required, Overall defining type of this clinical use definition.); (xsd)type:code>
[]< A categorisation of the issue, primarily for dividing warnings into subject heading areas such as "Pregnancy and Lactation", "Overdose", "Effects on Ability to Drive and Use Machines". Binding: clinical-use-definition-category (preferred, A categorisation for a clinical use information item.); (xsd)category:CodeableConcept>*
[]< The medication, product, substance, device, procedure etc. for which this is an indication.; (xsd)subject:(<ActivityDefinition>
|<BiologicallyDerivedProduct>
|<Device>
|<DeviceDefinition>
|<Medication>
|<MedicinalProductDefinition>
|<NutritionProduct>
|<PlanDefinition>
|<Substance>)>*
< Whether this is a current issue or one that has been retired etc. Binding: publication-status (preferred, The lifecycle status of an artifact.); (xsd)status:CodeableConcept>?
< Specifics for when this is a contraindication.; (xsd)contraindication:ClinicalUseDefinition.contraindication>?
< Specifics for when this is an indication.; (xsd)indication:ClinicalUseDefinition.indication>?
< Specifics for when this is an interaction.; (xsd)interaction:ClinicalUseDefinition.interaction>?
[]< The population group to which this applies.; (xsd)population:Group*>*
[]< Logic used by the clinical use definition.; (xsd)library:Library*>*
< Describe the possible undesirable effects (negative outcomes) from the use of the medicinal product as treatment.; (xsd)undesirableEffect:ClinicalUseDefinition.undesirableEffect>?
< A critical piece of information about environmental, health or physical risks or hazards that serve as caution to the user. For example 'Do not operate heavy machinery', 'May cause drowsiness', or 'Get medical advice/attention if you feel unwell'.; (xsd)warning:ClinicalUseDefinition.warning>?🔗 Specifics for when this is a contraindication.ClinicalUseDefinition.contraindication(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The situation that is being documented as contraindicating against this item. Binding: disease-symptom-procedure (example, A symptom, disease or procedure.); (xsd)diseaseSymptomProcedure:ObservationDefinition*>?
< The status of the disease or symptom for the contraindication, for example "chronic" or "metastatic". Binding: disease-status (example, The status of a disease or symptom.); (xsd)diseaseStatus:ObservationDefinition*>?
[]< A comorbidity (concurrent condition) or coinfection. Binding: disease-symptom-procedure (example, A symptom, disease or procedure.); (xsd)comorbidity:ObservationDefinition*>*
[]< The indication which this is a contraidication for.; (xsd)indication:ClinicalUseDefinition*>*
< An expression that returns true or false, indicating whether the indication is applicable or not, after having applied its other elements. The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.; (xsd)applicability:Expression>?
[]< Information about the use of the medicinal product in relation to other therapies described as part of the contraindication.; (xsd)otherTherapy:ClinicalUseDefinition.contraindication.otherTherapy>*🔗 Information about the use of the medicinal product in relation to other therapies described as part of the contraindication.ClinicalUseDefinition.contraindication.otherTherapy(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The type of relationship between the medicinal product indication or contraindication and another therapy. Binding: therapy-relationship-type (preferred, Classification of relationship between a therapy and a contraindication or an indication.); (xsd)relationshipType:CodeableConcept>
< Reference to a specific medication (active substance, medicinal product or class of products, biological, food etc.) as part of an indication or contraindication. Binding: therapy (example, A therapy.); (xsd)treatment:(<ActivityDefinition>
|<BiologicallyDerivedProduct>
|<Medication>
|<MedicinalProductDefinition>
|<NutritionProduct>
|<Substance>
|<SubstanceDefinition>)>🔗 Specifics for when this is an indication.ClinicalUseDefinition.indication(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The situation that is being documented as an indicaton for this item. Binding: disease-symptom-procedure (example, A symptom, disease or procedure.); (xsd)diseaseSymptomProcedure:ObservationDefinition*>?
< The status of the disease or symptom for the indication, for example "chronic" or "metastatic". Binding: disease-status (example, The status of a disease or symptom.); (xsd)diseaseStatus:ObservationDefinition*>?
[]< A comorbidity (concurrent condition) or coinfection as part of the indication. Binding: disease-symptom-procedure (example, A symptom, disease or procedure.); (xsd)comorbidity:ObservationDefinition*>*
< The intended effect, aim or strategy to be achieved. Binding: product-intended-use (preferred, The overall intended use of a product.); (xsd)intendedEffect:ObservationDefinition*>?
< Timing or duration information, that may be associated with use with the indicated condition e.g. Adult patients suffering from myocardial infarction (from a few days until less than 35 days), ischaemic stroke (from 7 days until less than 6 months).; (xsd)duration:(<Range>
|<string>)>?
[]< An unwanted side effect or negative outcome that may happen if you use the drug (or other subject of this resource) for this indication.; (xsd)undesirableEffect:ClinicalUseDefinition*>*
< An expression that returns true or false, indicating whether the indication is applicable or not, after having applied its other elements. The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.; (xsd)applicability:Expression>?
[]< Information about the use of the medicinal product in relation to other therapies described as part of the indication.; (xsd)otherTherapy:ClinicalUseDefinition.contraindication.otherTherapy>*🔗 Specifics for when this is an interaction.ClinicalUseDefinition.interaction(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< The specific medication, product, food, substance etc. or laboratory test that interacts.; (xsd)interactant:ClinicalUseDefinition.interaction.interactant>*
< The type of the interaction e.g. drug-drug interaction, drug-food interaction, drug-lab test interaction. Binding: interaction-type (example, A categorisation for an interaction between two substances.); (xsd)type:CodeableConcept>?
< The effect of the interaction, for example "reduced gastric absorption of primary medication". Binding: interaction-effect (example, A interaction effect of clinical use of a medication or other substance.); (xsd)effect:ObservationDefinition*>?
< The incidence of the interaction, e.g. theoretical, observed. Binding: interaction-incidence (example, A categorisation for incidence of occurence of an interaction.); (xsd)incidence:CodeableConcept>?
[]< Actions for managing the interaction. Binding: interaction-management (example, A type of management for an interaction of a medication or other substance.); (xsd)management:CodeableConcept>*🔗 The specific medication, product, food, substance etc. or laboratory test that interacts.ClinicalUseDefinition.interaction.interactant(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The specific medication, product, food, substance etc. or laboratory test that interacts. Binding: interactant (example, An interactant - a substance that may have a clinically significant effect on another.); (xsd)item:(<BiologicallyDerivedProduct>
|<CodeableConcept>
|<Medication>
|<MedicinalProductDefinition>
|<NutritionProduct>
|<ObservationDefinition>
|<Substance>)>🔗 Describe the possible undesirable effects (negative outcomes) from the use of the medicinal product as treatment.ClinicalUseDefinition.undesirableEffect(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The situation in which the undesirable effect may manifest. Binding: undesirable-effect-symptom (example, An undesirable effect of clinical use.); (xsd)symptomConditionEffect:ObservationDefinition*>?
< High level classification of the effect. Binding: undesirable-effect-classification (example, A categorisation for an undesirable effect.); (xsd)classification:CodeableConcept>?
< How often the effect is seen. Binding: undesirable-effect-frequency (example, A categorisation for a frequency of occurence of an undesirable effect.); (xsd)frequencyOfOccurrence:CodeableConcept>?🔗 A critical piece of information about environmental, health or physical risks or hazards that serve as caution to the user. For example 'Do not operate heavy machinery', 'May cause drowsiness', or 'Get medical advice/attention if you feel unwell'.ClinicalUseDefinition.warning(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A textual definition of this warning, with formatting.; (xsd)description:markdown>?
< A coded or unformatted textual definition of this warning. Binding: warning-type (example, Classification of warning type.); (xsd)code:CodeableConcept>?🔗 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 contentscode(xsd)(doc)=
<#base:string>
< unique id for the element within a resource (for internal references); (xsd)id:string>?
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< Primitive value for code; (xsd)value:string>?🔗 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(xsd)(doc)=
<#base:DataType>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< 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.; (xsd)coding:Coding>*
< 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.; (xsd)text:string>?🔗 A reference to a resource (by instance), or instead, a reference to a concept defined in a terminology or ontology (by class).CodeableReference(xsd)(doc)=
<#base:DataType>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< A reference to a concept - e.g. the information is identified by its general class to the degree of precision found in the terminology.; (xsd)concept:CodeableConcept>?
< A reference to a resource the provides exact details about the information being referenced.; (xsd)reference:Resource*>?🔗 The CodeSystem resource is used to declare the existence of and describe a code system or code system supplement and its key properties, and optionally define a part or all of its content.CodeSystem(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< An absolute URI that is used to identify this code system when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this code system is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the code system is stored on different servers. This is used in [Coding](datatypes.html#Coding).system. Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.
The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions).
In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.; (xsd)url:uri>?
[]< A formal identifier that is used to identify this code system when it is represented in other formats, or referenced in a specification, model, design or an instance. Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this code system outside of FHIR, where it is not possible to use the logical URI. Note that HL7 defines at least three identifiers for many of its code systems - the FHIR canonical URL, the OID and the V2 Table 0396 mnemonic code.; (xsd)identifier:Identifier>*
< The identifier that is used to identify this version of the code system when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the code system author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. This is used in [Coding](datatypes.html#Coding).version. There may be different code system instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the code system with the format [url]|[version]. The version SHOULD NOT contain a '#' - see [Business Version](resource.html#bv-format).; (xsd)version:string>?
< Indicates the mechanism used to compare versions to determine which CodeSystem is more current. If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined. Binding: version-algorithm (extensible, ); (xsd)versionAlgorithm:(<Coding>
|<string>)>?
< A natural language name identifying the code system. This name should be usable as an identifier for the module by machine processing applications such as code generation. The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.; (xsd)name:string>?
< A short, descriptive, user-friendly title for the code system. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.; (xsd)title:string>?
< The status of this code system. Enables tracking the life-cycle of the content. Allows filtering of code systems that are appropriate for use versus not.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization). Binding: publication-status (required, The lifecycle status of an artifact.); (xsd)status:code>
< A Boolean value to indicate that this code system is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. Allows filtering of code systems that are appropriate for use versus not.; (xsd)experimental:boolean>?
< The date (and optionally time) when the code system was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the code system changes. The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the code system. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)date:dateTime>?
< The name of the organization or individual responsible for the release and ongoing maintenance of the code system. Usually an organization but may be an individual. The publisher (or steward) of the code system is the organization or individual primarily responsible for the maintenance and upkeep of the code system. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the code system. This item SHOULD be populated unless the information is available from context.; (xsd)publisher:string>?
[]< Contact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)contact:ContactDetail>*
< A free text natural language description of the code system from a consumer's perspective. This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the code system as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the code system is presumed to be the predominant language in the place the code system was created).; (xsd)description:markdown>?
[]< The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate code system instances. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.; (xsd)useContext:UsageContext>*
[]< A legal or geographic region in which the code system is intended to be used. It may be possible for the code system to be used in jurisdictions other than those for which it was originally designed or intended.
DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.) Binding: jurisdiction (extensible, Countries and regions within which this artifact is targeted for use.); (xsd)jurisdiction:CodeableConcept>*
< Explanation of why this code system is needed and why it has been designed as it has. This element does not describe the usage of the code system. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this code system.; (xsd)purpose:markdown>?
< A copyright statement relating to the code system and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the code system. ... Sometimes, the copyright differs between the code system and the codes that are included. The copyright statement should clearly differentiate between these when required.; (xsd)copyright:markdown>?
< A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved'). The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.; (xsd)copyrightLabel:string>?
< The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)approvalDate:date>?
< The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. If specified, this date follows the original approval date.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)lastReviewDate:date>?
< The period during which the CodeSystem content was or is planned to be in active use. The effective period for a CodeSystem determines when the content is applicable for usage and is independent of publication and review dates. For example, a system intended to be used for the year 2016 might be published in 2015.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)effectivePeriod:Period>?
[]< Descriptions related to the content of the CodeSystem. Topics provide a high-level categorization as well as keywords for the CodeSystem that can be useful for filtering and searching. DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'topic' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#topic and useContext.valueCodeableConcept indicating the topic) Binding: definition-topic (example, ); (xsd)topic:CodeableConcept>*
[]< An individiual or organization primarily involved in the creation and maintenance of the CodeSystem.; (xsd)author:ContactDetail>*
[]< An individual or organization primarily responsible for internal coherence of the CodeSystem.; (xsd)editor:ContactDetail>*
[]< An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the CodeSystem. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)reviewer:ContactDetail>*
[]< An individual or organization asserted by the publisher to be responsible for officially endorsing the CodeSystem for use in some setting. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)endorser:ContactDetail>*
[]< Related artifacts such as additional documentation, justification, dependencies, bibliographic references, and predecessor and successor artifacts. Each related artifact is either an attachment, or a reference to another resource, but not both.; (xsd)relatedArtifact:RelatedArtifact>*
< If code comparison is case sensitive when codes within this system are compared to each other. If this value is missing, then it is not specified whether a code system is case sensitive or not. When the rule is not known, Postel's law should be followed: produce codes with the correct case, and accept codes in any case. This element is primarily provided to support validation software.; (xsd)caseSensitive:boolean>?
< Canonical reference to the value set that contains all codes in the code system independent of code status. The definition of the value set SHALL include all codes from this code system, independent of concept status, and only codes from this code system. It SHALL be immutable, and operations SHOULD support validation of any allowed code compositions.; (xsd)valueSet:ValueSet*>?
< The meaning of the hierarchy of concepts as represented in this resource. Note that other representations might have a different hierarchy or none at all, and represent the information using properties. Binding: codesystem-hierarchy-meaning (required, The meaning of the hierarchy of concepts in a code system.); (xsd)hierarchyMeaning:code>?
< The code system defines a compositional (post-coordination) grammar. Note that the code system resource does not define what the compositional grammar is, only whether or not there is one.; (xsd)compositional:boolean>?
< This flag is used to signify that the code system does not commit to concept permanence across versions. If true, a version must be specified when referencing this code system. Best practice is that code systems do not redefine concepts, or that if concepts are redefined, a new code system definition is created. But this is not always possible, so some code systems may be defined as 'versionNeeded'.
Most code systems occasionally refine the displays defined for concepts between versions. Contexts in which the concept display values are validated may require that the version be specified for some code systems irrespective of the value of this property.; (xsd)versionNeeded:boolean>?
< The extent of the content of the code system (the concepts and codes it defines) are represented in this resource instance. Binding: codesystem-content-mode (required, The extent of the content of the code system (the concepts and codes it defines) are represented in a code system resource.); (xsd)content:code>
< The canonical URL of the code system that this code system supplement is adding designations and properties to. The most common use of a code system supplement is to add additional language support.; (xsd)supplements:CodeSystem*>?
< The total number of concepts defined by the code system. Where the code system has a compositional grammar, the basis of this count is defined by the system steward. The count of concepts defined in this resource cannot be more than this value but may be less for several reasons - see the content element.; (xsd)count:unsignedInt>?
[]< A filter that can be used in a value set compose statement when selecting concepts using a filter. Note that filters defined in code systems usually require custom code on the part of any terminology engine that will make them available for use in value set filters. For this reason, they are generally only seen in high value published terminologies.; (xsd)filter:CodeSystem.filter>*
[]< A property defines an additional slot through which additional information can be provided about a concept. Multiple occurrences of CodeSystem.concept.property may occur for a CodeSystem.property where CodeSystem.concept.property.code is the same and CodeSystem.concept.property.value differs. For example: multiple designations for a single concept.; (xsd)property:CodeSystem.property>*
[]< Concepts that are in the code system. The concept definitions are inherently hierarchical, but the definitions must be consulted to determine what the meanings of the hierarchical relationships are. If this is empty, it means that the code system resource does not represent the content of the code system.; (xsd)concept:CodeSystem.concept>*🔗 Concepts that are in the code system. The concept definitions are inherently hierarchical, but the definitions must be consulted to determine what the meanings of the hierarchical relationships are. If this is empty, it means that the code system resource does not represent the content of the code system.CodeSystem.concept(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A code - a text symbol - that uniquely identifies the concept within the code system.; (xsd)code>
< A human readable string that is the recommended default way to present this concept to a user.; (xsd)display:string>?
< The formal definition of the concept. The code system resource does not make formal definitions required, because of the prevalence of legacy systems. However, they are highly recommended, as without them there is no formal meaning associated with the concept.; (xsd)definition:string>?
[]< Additional representations for the concept - other languages, aliases, specialized purposes, used for particular purposes, etc. Concepts have both a ```display``` and an array of ```designation```. The display is equivalent to a special designation with an implied ```designation.use``` of "primary code" and a language equal to the [Resource Language](resource.html#language).; (xsd)designation:CodeSystem.concept.designation>*
[]< A property value for this concept.; (xsd)property:CodeSystem.concept.property>*
[]< Defines children of a concept to produce a hierarchy of concepts. The nature of the relationships is variable (is-a/contains/categorizes) - see hierarchyMeaning.; (xsd)concept:CodeSystem.concept>*🔗 Additional representations for the concept - other languages, aliases, specialized purposes, used for particular purposes, etc. Concepts have both a ```display``` and an array of ```designation```. The display is equivalent to a special designation with an implied ```designation.use``` of "primary code" and a language equal to the [Resource Language](resource.html#language).CodeSystem.concept.designation(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The language this designation is defined for. In the absence of a language, the resource language applies. Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< A code that details how this designation would be used. If no use is provided, the designation can be assumed to be suitable for general display to a human user. Binding: designation-use (extensible, Details of how a designation would be used.); (xsd)use:Coding>?
[]< Additional codes that detail how this designation would be used, if there is more than one use. This was added rather than increasing the cardinality of .use to 0..* in order to maintain backward compatibility. Binding: designation-use (extensible, Details of how a designation would be used.); (xsd)additionalUse:Coding>*
< The text value for this designation.; (xsd)value:string>🔗 A property value for this concept.CodeSystem.concept.property(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A code that is a reference to CodeSystem.property.code.; (xsd)code>
(<valueBoolean:boolean>
|<valueCode:code>
|<valueCoding:Coding>
|<valueDateTime:dateTime>
|<valueDecimal:decimal>
|<valueInteger:integer>
|<valueString:string>)🔗 A filter that can be used in a value set compose statement when selecting concepts using a filter. Note that filters defined in code systems usually require custom code on the part of any terminology engine that will make them available for use in value set filters. For this reason, they are generally only seen in high value published terminologies.CodeSystem.filter(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The code that identifies this filter when it is used as a filter in [ValueSet](valueset.html#).compose.include.filter.; (xsd)code>
< A description of how or why the filter is used.; (xsd)description:string>?
[]< A list of operators that can be used with the filter. Binding: filter-operator (required, The kind of operation to perform as a part of a property based filter.); (xsd)operator:code>+
< A description of what the value for the filter should be.; (xsd)value:string>🔗 A property defines an additional slot through which additional information can be provided about a concept. Multiple occurrences of CodeSystem.concept.property may occur for a CodeSystem.property where CodeSystem.concept.property.code is the same and CodeSystem.concept.property.value differs. For example: multiple designations for a single concept.CodeSystem.property(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A code that is used to identify the property. The code is used internally (in CodeSystem.concept.property.code) and also externally, such as in property filters.; (xsd)code>
< Reference to the formal meaning of the property. One possible source of meaning is the [Concept Properties](codesystem-concept-properties.html) code system.; (xsd)uri>?
< A description of the property- why it is defined, and how its value might be used.; (xsd)description:string>?
< The type of the property value. Properties of type "code" contain a code defined by the code system (e.g. a reference to another defined concept). Binding: concept-property-type (required, The type of a property value.); (xsd)type:code>🔗 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(xsd)(doc)=
<#base:DataType>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< 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 be an absolute reference to some definition that establishes the system clearly and unambiguously.; (xsd)system:uri>?
< 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.; (xsd)version:string>?
< 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).; (xsd)code>?
< A representation of the meaning of the code in the system, following the rules of the system.; (xsd)display:string>?
< 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.; (xsd)userSelected:boolean>?🔗 A clinical or business level record of information being transmitted or shared; e.g. an alert that was sent to a responsible provider, a public health agency communication to a provider/reporter in response to a case report for a reportable condition.Communication(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< Business identifiers assigned to this communication by the performer or other systems which remain constant as the resource is updated and propagates from server to server. This is a business identifier, not a resource identifier (see [discussion](resource.html#identifiers)). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.; (xsd)identifier:Identifier>*
[]< The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication.; (xsd)instantiatesCanonical:(<ActivityDefinition>
|<Measure>
|<OperationDefinition>
|<PlanDefinition>
|<Questionnaire>)>*
[]< The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication. This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.; (xsd)instantiatesUri:uri>*
[]< An order, proposal or plan fulfilled in whole or in part by this Communication. This must point to some sort of a 'Request' resource, such as CarePlan, CommunicationRequest, ServiceRequest, MedicationRequest, etc.; (xsd)basedOn:Resource*>*
[]< A larger event (e.g. Communication, Procedure) of which this particular communication is a component or step. The event the communication was part of - e.g. if you disclosed as "part" of counselling, it would be partOf that Procedure.; (xsd)partOf:Resource*>*
[]< Prior communication that this communication is in response to.; (xsd)inResponseTo:Communication*>*
< The status of the transmission. This element is labeled as a modifier because the status contains the codes aborted and entered-in-error that mark the communication as not currently valid. Binding: event-status (required, The status of the communication.); (xsd)status:code>
< Captures the reason for the current state of the Communication. This is generally only used for "exception" statuses such as "not-done", "suspended" or "aborted". The reason for performing the event at all is captured in reasonCode, not here. Binding: communication-not-done-reason (example, Codes for the reason why a communication did not happen.); (xsd)statusReason:CodeableConcept>?
[]< The type of message conveyed such as alert, notification, reminder, instruction, etc. There may be multiple axes of categorization and one communication may serve multiple purposes. Binding: communication-category (example, Codes for general categories of communications such as alerts, instructions, etc.); (xsd)category:CodeableConcept>*
< Characterizes how quickly the planned or in progress communication must be addressed. Includes concepts such as stat, urgent, routine. Used to prioritize workflow (such as which communication to read first) when the communication is planned or in progress. Binding: request-priority (required, Codes indicating the relative importance of a communication.); (xsd)priority:code>?
[]< A channel that was used for this communication (e.g. email, fax). Binding: http://terminology.hl7.org/ValueSet/v3-ParticipationMode (example, Codes for communication mediums such as phone, fax, email, in person, etc.); (xsd)medium:CodeableConcept>*
< The patient or group that was the focus of this communication.; (xsd)subject:(<Group>
|<Patient>)>?
< Description of the purpose/content, similar to a subject line in an email. Communication.topic.text can be used without any codings. Binding: communication-topic (example, Codes describing the purpose or content of the communication.); (xsd)topic:CodeableConcept>?
[]< Other resources that pertain to this communication and to which this communication should be associated. Don't use Communication.about element when a more specific element exists, such as basedOn or reasonReference.; (xsd)about:Resource*>*
< The Encounter during which this Communication was created or to which the creation of this record is tightly associated. This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter.; (xsd)encounter:Encounter*>?
< The time when this communication was sent.; (xsd)sent:dateTime>?
< The time when this communication arrived at the destination.; (xsd)received:dateTime>?
[]< The entity (e.g. person, organization, clinical information system, care team or device) which is the target of the communication. If receipts need to be tracked by an individual, a separate resource instance will need to be created for each recipient. Multiple recipient communications are intended where either receipts are not tracked (e.g. a mass mail-out) or a receipt is captured in aggregate (all emails confirmed received by a particular time).; (xsd)recipient:(<CareTeam>
|<Device>
|<Endpoint>
|<Group>
|<HealthcareService>
|<Location>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>*
< The entity (e.g. person, organization, clinical information system, or device) which is the source of the communication.; (xsd)sender:(<CareTeam>
|<Device>
|<Endpoint>
|<HealthcareService>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>?
[]< The reason or justification for the communication. Textual reasons can be captured using reason.concept.text. Binding: clinical-findings (example, Codes for describing reasons for the occurrence of a communication.); (xsd)reason:Resource*>*
[]< Text, attachment(s), or resource(s) that was communicated to the recipient.; (xsd)payload:Communication.payload>*
[]< Additional notes or commentary about the communication by the sender, receiver or other interested parties.; (xsd)note:Annotation>*🔗 Text, attachment(s), or resource(s) that was communicated to the recipient.Communication.payload(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A communicated content (or for multi-part communications, one portion of the communication). The content can be codified or textual. As an example of codified content, when working with machine generated communications, the payload may be drawn from a finite, terminology defined set of communications, especially for short, status update kinds of communications where more of a natural language approach isn't appropriate.
If the content isn't codified, contentCodeableConcept.text can be used.
When using contentCodeableConcept, the CodeableConcept is what is being communicated and is not a categorization of the content.; (xsd)content:(<Attachment>
|<CodeableConcept>
|<Resource>)>🔗 A request to convey information; e.g. the CDS system proposes that an alert be sent to a responsible provider, the CDS system proposes that the public health agency be notified about a reportable condition.CommunicationRequest(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< Business identifiers assigned to this communication request by the performer or other systems which remain constant as the resource is updated and propagates from server to server. This is a business identifier, not a resource identifier (see [discussion](resource.html#identifiers)). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.; (xsd)identifier:Identifier>*
[]< A plan or proposal that is fulfilled in whole or in part by this request.; (xsd)basedOn:Resource*>*
[]< Completed or terminated request(s) whose function is taken by this new request. The replacement could be because the initial request was immediately rejected (due to an issue) or because the previous request was completed, but the need for the action described by the request remains ongoing.; (xsd)replaces:CommunicationRequest*>*
< A shared identifier common to multiple independent Request instances that were activated/authorized more or less simultaneously by a single author. The presence of the same identifier on each request ties those requests together and may have business ramifications in terms of reporting of results, billing, etc. E.g. a requisition number shared by a set of lab tests ordered together, or a prescription number shared by all meds ordered at one time. Requests are linked either by a "basedOn" relationship (i.e. one request is fulfilling another) or by having a common requisition. Requests that are part of the same requisition are generally treated independently from the perspective of changing their state or maintaining them after initial creation.; (xsd)groupIdentifier:Identifier>?
< The status of the proposal or order. Binding: request-status (required, The status of the communication request.); (xsd)status:code>
< Captures the reason for the current state of the CommunicationRequest. This is generally only used for "exception" statuses such as "on-hold" or "revoked". The reason why the CommunicationRequest was created at all is captured in reasonCode, not here. Binding: communication-request-status-reason (example, Codes identifying the reason for the current state of a request.); (xsd)statusReason:CodeableConcept>?
< Indicates the level of authority/intentionality associated with the CommunicationRequest and where the request fits into the workflow chain. This element is expected to be immutable. E.g. A "proposal" instance should never change to be a "plan" instance or "order" instance. Instead, a new instance 'basedOn' the prior instance should be created with the new 'intent' value.
One exception to this is that the granularity of CommunicationRequest.intent is allowed to change. For example, a Request identified as an "order" might later be clarified to be a "filler-order". Or, in rarer cases (to meet recipient constraints), the reverse might also occur. Binding: request-intent (required, Codes indicating the degree of authority/intentionality associated with a request.); (xsd)intent:code>
[]< The type of message to be sent such as alert, notification, reminder, instruction, etc. There may be multiple axes of categorization and one communication request may serve multiple purposes. Binding: communication-category (example, Codes for general categories of communications such as alerts, instruction, etc.); (xsd)category:CodeableConcept>*
< Characterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine. Binding: request-priority (required, Codes indicating the relative importance of a communication request.); (xsd)priority:code>?
< If true indicates that the CommunicationRequest is asking for the specified action to *not* occur. The attributes provided with the request qualify what is not to be done.; (xsd)doNotPerform:boolean>?
[]< A channel that was used for this communication (e.g. email, fax). Binding: http://terminology.hl7.org/ValueSet/v3-ParticipationMode (example, Codes for communication mediums such as phone, fax, email, in person, etc.); (xsd)medium:CodeableConcept>*
< The patient or group that is the focus of this communication request.; (xsd)subject:(<Group>
|<Patient>)>?
[]< Other resources that pertain to this communication request and to which this communication request should be associated. Don't use CommunicationRequest.about element when a more specific element exists, such as basedOn, reasonReference, or replaces.; (xsd)about:Resource*>*
< The Encounter during which this CommunicationRequest was created or to which the creation of this record is tightly associated. This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter.; (xsd)encounter:Encounter*>?
[]< Text, attachment(s), or resource(s) to be communicated to the recipient.; (xsd)payload:CommunicationRequest.payload>*
< The time when this communication is to occur.; (xsd)occurrence:(<dateTime>
|<Period>)>?
< For draft requests, indicates the date of initial creation. For requests with other statuses, indicates the date of activation.; (xsd)authoredOn:dateTime>?
< The device, individual, or organization who asks for the information to be shared.; (xsd)requester:(<Device>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>?
[]< The entity (e.g. person, organization, clinical information system, device, group, or care team) which is the intended target of the communication.; (xsd)recipient:(<CareTeam>
|<Device>
|<Endpoint>
|<Group>
|<HealthcareService>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>*
[]< The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication.; (xsd)informationProvider:(<Device>
|<Endpoint>
|<HealthcareService>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>*
[]< Describes why the request is being made in coded or textual form. Textual reasons can be captured using reasonCode.text. Binding: http://terminology.hl7.org/ValueSet/v3-ActReason (example, Codes for describing reasons for the occurrence of a communication.); (xsd)reason:Resource*>*
[]< Comments made about the request by the requester, sender, recipient, subject or other participants.; (xsd)note:Annotation>*🔗 Text, attachment(s), or resource(s) to be communicated to the recipient.CommunicationRequest.payload(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The communicated content (or for multi-part communications, one portion of the communication). The content can be codified or textual. As an example of codified content, when working with machine generated communications, the payload may be drawn from a finite, terminology defined set of communications, especially for short, status update kinds of communications where more of a natural language approach isn't appropriate.
If the content isn't codified, contentCodeableConcept.text can be used.
When using contentCodeableConcept, the CodeableConcept is what is being communicated and is not a categorization of the content.; (xsd)content:(<Attachment>
|<CodeableConcept>
|<Resource>)>🔗 A compartment definition that defines how resources are accessed on a server. In FHIR, search is not performed directly on a resource (by XML or JSON path), but on a named parameter that maps into the resource content.CompartmentDefinition(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< An absolute URI that is used to identify this compartment definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this compartment definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the compartment definition is stored on different servers. Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.
The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions).
In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.; (xsd)url:uri>
< The identifier that is used to identify this version of the compartment definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the compartment definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. There may be different compartment definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the compartment definition with the format [url]|[version]. The version SHOULD NOT contain a '#' - see [Business Version](resource.html#bv-format).; (xsd)version:string>?
< Indicates the mechanism used to compare versions to determine which is more current. If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined. Binding: version-algorithm (extensible, ); (xsd)versionAlgorithm:(<Coding>
|<string>)>?
< A natural language name identifying the compartment definition. This name should be usable as an identifier for the module by machine processing applications such as code generation. The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.This is often the same as the code for the parameter, but does not need to be.; (xsd)name:string>
< A short, descriptive, user-friendly title for the capability statement. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.; (xsd)title:string>?
< The status of this compartment definition. Enables tracking the life-cycle of the content. Allows filtering of compartment definitions that are appropriate for use versus not.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization). Binding: publication-status (required, The lifecycle status of an artifact.); (xsd)status:code>
< A Boolean value to indicate that this compartment definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. Allows filtering of compartment definitions that are appropriate for use versus not.; (xsd)experimental:boolean>?
< The date (and optionally time) when the compartment definition was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the compartment definition changes. The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the compartment definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)date:dateTime>?
< The name of the organization or individual responsible for the release and ongoing maintenance of the compartment definition. Usually an organization but may be an individual. The publisher (or steward) of the compartment definition is the organization or individual primarily responsible for the maintenance and upkeep of the compartment definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the compartment definition. This item SHOULD be populated unless the information is available from context.; (xsd)publisher:string>?
[]< Contact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)contact:ContactDetail>*
< A free text natural language description of the compartment definition from a consumer's perspective. This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the compartment definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the compartment definition is presumed to be the predominant language in the place the compartment definition was created).; (xsd)description:markdown>?
[]< The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate compartment definition instances. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.; (xsd)useContext:UsageContext>*
< Explanation of why this compartment definition is needed and why it has been designed as it has. This element does not describe the usage of the compartment definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this compartment definition.; (xsd)purpose:markdown>?
< Which compartment this definition describes. Only the specification can define the compartments that can exist. Servers can choose to support them. Binding: compartment-type (required, Which type a compartment definition describes.); (xsd)code>
< Whether the search syntax is supported,. Servers may define and use compartments to manage logical access without implementing the compartment related syntax.; (xsd)search:boolean>
[]< Information about how a resource is related to the compartment.; (xsd)resource:CompartmentDefinition.resource>*🔗 Information about how a resource is related to the compartment.CompartmentDefinition.resource(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The name of a resource supported by the server. Binding: resource-types (required, One of the resource types defined as part of this version of FHIR.); (xsd)code>
[]< The name of a search parameter that represents the link to the compartment. More than one may be listed because a resource may be linked to a compartment in more than one way,. If no search parameters are listed, then the resource is not linked to the compartment.; (xsd)param:string>*
< Additional documentation about the resource and compartment.; (xsd)documentation:string>?
< Search Parameter for mapping requests made with $everything.start (e.g. on [Patient.$everything](patient-operation-everything.html)).; (xsd)startParam:uri>?
< Search Parameter for mapping requests made with $everything.end (e.g. on [Patient.$everything](patient-operation-everything.html)).; (xsd)endParam:uri>?🔗 A set of healthcare-related information that is assembled together into a single logical package that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. A Composition defines the structure and narrative content necessary for a document. However, a Composition alone does not constitute a document. Rather, the Composition must be the first entry in a Bundle where Bundle.type=document, and any other resources referenced from Composition must be included as subsequent entries in the Bundle (for example Patient, Practitioner, Encounter, etc.). While the focus of this specification is on patient-specific clinical statements, this resource can also apply to other healthcare-related statements such as study protocol designs, healthcare invoices and other activities that are not necessarily patient-specific or clinical.Composition(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< An absolute URI that is used to identify this Composition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this Composition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the Composition is stored on different servers. Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.; (xsd)url:uri>?
[]< A version-independent identifier for the Composition. This identifier stays constant as the composition is changed over time. Similar to ClinicalDocument/setId in CDA. See discussion in resource definition for how these relate.; (xsd)identifier:Identifier>*
< An explicitly assigned identifer of a variation of the content in the Composition. While each resource, including the composition itself, has its own version identifier, this is a formal identifier for the logical version of the Composition as a whole. It would remain constant if the resources were moved to a new server, and all got new individual resource versions, for example.; (xsd)version:string>?
< The workflow/clinical status of this composition. The status is a marker for the clinical standing of the document. If a composition is marked as withdrawn, the compositions/documents in the series, or data from the composition or document series, should never be displayed to a user without being clearly marked as untrustworthy. The flag "entered-in-error" is why this element is labeled as a modifier of other elements.
Some reporting work flows require that the original narrative of a final document never be altered; instead, only new narrative can be added. The composition resource has no explicit status for explicitly noting whether this business rule is in effect. This would be handled by an extension if required. Binding: composition-status (required, The workflow/clinical status of the composition.); (xsd)status:code>
< Specifies the particular kind of composition (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the composition. For Composition type, LOINC is ubiquitous and strongly endorsed by HL7. Most implementation guides will require a specific LOINC code, or use LOINC as an extensible binding. Binding: doc-typecodes (preferred, Type of a composition.); (xsd)type:CodeableConcept>
[]< A categorization for the type of the composition - helps for indexing and searching. This may be implied by or derived from the code specified in the Composition Type. Binding: referenced-item-category (example, High-level kind of a clinical document at a macro level.); (xsd)category:CodeableConcept>*
[]< Who or what the composition is about. The composition can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of livestock, or a set of patients that share a common exposure). For clinical documents, this is usually the patient.; (xsd)subject:Resource*>*
< Describes the clinical encounter or type of care this documentation is associated with.; (xsd)encounter:Encounter*>?
< The composition editing time, when the composition was last logically changed by the author. The Last Modified Date on the composition may be after the date of the document was attested without being changed. This means that the date on an amended document is the date of the amendment, not the date of original authorship.; (xsd)date:dateTime>
[]< The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate Composition instances. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.; (xsd)useContext:UsageContext>*
[]< Identifies who is responsible for the information in the composition, not necessarily who typed it in.; (xsd)author:(<Device>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>+
< A natural language name identifying the {{title}}. This name should be usable as an identifier for the module by machine processing applications such as code generation. The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.; (xsd)name:string>?
< Official human-readable label for the composition. For many compositions, the title is the same as the text or a display name of Composition.type (e.g. a "consultation" or "progress note"). Note that CDA does not make title mandatory, but there are no known cases where it is useful for title to be omitted, so it is mandatory here. Feedback on this requirement is welcome during the trial use period.; (xsd)title:string>
[]< For any additional notes. A comment, general note or annotation not coded elsewhere.; (xsd)note:Annotation>*
[]< A participant who has attested to the accuracy of the composition/document. Only list each attester once.; (xsd)attester:Composition.attester>*
< Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information. This is useful when documents are derived from a composition - provides guidance for how to get the latest version of the document. This is optional because this is sometimes not known by the authoring system, and can be inferred by context. However, it is important that this information be known when working with a derived document, so providing a custodian is encouraged.; (xsd)custodian:Organization*>?
[]< Relationships that this composition has with other compositions or documents that already exist. To reference (using relatesTo) a Bundle of type "document" or another Composition where you only have the identifier, use a resourceReference with an identifier.\
When a Composition is an alternate representation of another type of document e.g. CDA, the other document could be referenced in a DocumentReference resource.
Here is an example of using relatesTo to reference another Bundle of type "document" or Composition where you only have the identifier:
```
"relatesTo": [{
"type": "replaces",
"resourceReference": {
"identifier": {
"system": "...",
"value": "..."
}
}
}]
```; (xsd)relatesTo:RelatedArtifact>*
[]< The clinical service, such as a colonoscopy or an appendectomy, being documented. The event needs to be consistent with the type element, though can provide further information if desired.; (xsd)event:Composition.event>*
[]< The root of the sections that make up the composition.; (xsd)section:Composition.section>*🔗 A participant who has attested to the accuracy of the composition/document. Only list each attester once.Composition.attester(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The type of attestation the authenticator offers. Binding: composition-attestation-mode (preferred, The way in which a person authenticated a composition.); (xsd)mode:CodeableConcept>
< When the composition was attested by the party.; (xsd)time:dateTime>?
< Who attested the composition in the specified way.; (xsd)party:(<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>?🔗 The clinical service, such as a colonoscopy or an appendectomy, being documented. The event needs to be consistent with the type element, though can provide further information if desired.Composition.event(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The period of time covered by the documentation. There is no assertion that the documentation is a complete representation for this period, only that it documents events during this time.; (xsd)period:Period>?
[]< Represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the typeCode, such as a "History and Physical Report" in which case the procedure being documented is necessarily a "History and Physical" act. The events may be included as a code or as a reference to an other resource. An event can further specialize the act inherent in the typeCode, such as where it is simply "Procedure Report" and the procedure was a "colonoscopy". If one or more events are included, they SHALL NOT conflict with the values inherent in the classCode, practiceSettingCode or typeCode, as such a conflict would create an ambiguous situation. This short list of codes is provided to be used as key words for certain types of queries. Binding: http://terminology.hl7.org/ValueSet/v3-ActCode (example, This list of codes represents the main clinical acts being documented.); (xsd)detail:Resource*>*🔗 The root of the sections that make up the composition.Composition.section(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents. The title identifies the section for a human reader. The title must be consistent with the narrative of the resource that is the target of the section.content reference. Generally, sections SHOULD have titles, but in some documents, it is unnecessary or inappropriate. Typically, this is where a section has subsections that have their own adequately distinguishing title, or documents that only have a single section. Most Implementation Guides will make section title to be a required element.; (xsd)title:string>?
< A code identifying the kind of content contained within the section. This must be consistent with the section title. The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document.
If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code. Binding: doc-section-codes (example, Classification of a section of a composition/document.); (xsd)code:CodeableConcept>?
[]< Identifies who is responsible for the information in this section, not necessarily who typed it in.; (xsd)author:(<Device>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>*
< The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources). Typically, sections in a doument are about the subject of the document, whether that is a patient, or group of patients, location, or device, or whatever. For some kind of documents, some sections actually contain data about related entities. Typical examples are a section in a newborn discharge summary concerning the mother, or family history documents, with a section about each family member, though there are many other examples.; (xsd)focus:Resource*>?
< A human-readable narrative that contains the attested content of the section, 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. Document profiles may define what content should be represented in the narrative to ensure clinical safety.; (xsd)text:Narrative>?
< Specifies the order applied to the items in the section entries. Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order. Binding: list-order (preferred, What order applies to the items in the entry.); (xsd)orderedBy:CodeableConcept>?
[]< A reference to the actual resource from which the narrative in the section is derived. If there are no entries in the list, an emptyReason SHOULD be provided.; (xsd)entry:Resource*>*
< If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason. The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases. Binding: list-empty-reason (preferred, If a section is empty, why it is empty.); (xsd)emptyReason:CodeableConcept>?
[]< A nested sub-section within this section. Nested sections are primarily used to help human readers navigate to particular portions of the document.; (xsd)section:Composition.section>*🔗 This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical and non-clinical artifacts such as clinical decision support rules, order sets, protocols, and drug quality specifications.computableplandefinition(xsd)(doc)=
<#base:PlanDefinition>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< An absolute URI that is used to identify this plan definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this plan definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the plan definition is stored on different servers. Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.
The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions).
In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.; (xsd)url:uri>?
[]< A formal identifier that is used to identify this plan definition when it is represented in other formats, or referenced in a specification, model, design or an instance. Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this plan definition outside of FHIR, where it is not possible to use the logical URI.; (xsd)identifier:Identifier>*
< The identifier that is used to identify this version of the plan definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the plan definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts. There may be different plan definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the plan definition with the format [url]|[version]. The version SHOULD NOT contain a '#' - see [Business Version](resource.html#bv-format).; (xsd)version:string>?
< Indicates the mechanism used to compare versions to determine which is more current. If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined. Binding: version-algorithm (extensible, ); (xsd)versionAlgorithm:(<Coding>
|<string>)>?
< A natural language name identifying the plan definition. This name should be usable as an identifier for the module by machine processing applications such as code generation. The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.; (xsd)name:string>?
< A short, descriptive, user-friendly title for the plan definition. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.; (xsd)title:string>?
< An explanatory or alternate title for the plan definition giving additional information about its content.; (xsd)subtitle:string>?
< A high-level category for the plan definition that distinguishes the kinds of systems that would be interested in the plan definition. Binding: plan-definition-type (extensible, The type of PlanDefinition.); (xsd)type:CodeableConcept>?
< The status of this plan definition. Enables tracking the life-cycle of the content. Allows filtering of plan definitions that are appropriate for use versus not.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization). Binding: publication-status (required, The lifecycle status of an artifact.); (xsd)status:code>
< A Boolean value to indicate that this plan definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. Allows filtering of plan definitions that are appropriate for use versus not.; (xsd)experimental:boolean>?
< A code, group definition, or canonical reference that describes or identifies the intended subject of the plan definition. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource. Note that the choice of canonical for the subject element was introduced in R4B to support pharmaceutical quality use cases. To ensure as much backwards-compatibility as possible, it is recommended to only use the new canonical type with these use cases. Binding: participant-resource-types (extensible, The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).); (xsd)subject:(<AdministrableProductDefinition>
|<CodeableConcept>
|<EvidenceVariable>
|<Group>
|<ManufacturedItemDefinition>
|<MedicinalProductDefinition>
|<PackagedProductDefinition>
|<SubstanceDefinition>)>?
< The date (and optionally time) when the plan definition was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the plan definition changes. The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the plan definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)date:dateTime>?
< The name of the organization or individual responsible for the release and ongoing maintenance of the plan definition. Usually an organization but may be an individual. The publisher (or steward) of the plan definition is the organization or individual primarily responsible for the maintenance and upkeep of the plan definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the plan definition. This item SHOULD be populated unless the information is available from context.; (xsd)publisher:string>?
[]< Contact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)contact:ContactDetail>*
< A free text natural language description of the plan definition from a consumer's perspective. This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the plan definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the plan definition is presumed to be the predominant language in the place the plan definition was created).; (xsd)description:markdown>?
[]< The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate plan definition instances. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.; (xsd)useContext:UsageContext>*
[]< A legal or geographic region in which the plan definition is intended to be used. It may be possible for the plan definition to be used in jurisdictions other than those for which it was originally designed or intended.
DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.) Binding: jurisdiction (extensible, Countries and regions within which this artifact is targeted for use.); (xsd)jurisdiction:CodeableConcept>*
< Explanation of why this plan definition is needed and why it has been designed as it has. This element does not describe the usage of the plan definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this plan definition.; (xsd)purpose:markdown>?
< A detailed description of how the plan definition is used from a clinical perspective.; (xsd)usage:markdown>?
< A copyright statement relating to the plan definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the plan definition. The short copyright declaration (e.g. (c) '2015+ xyz organization' should be sent in the copyrightLabel element.; (xsd)copyright:markdown>?
< A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved'). The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.; (xsd)copyrightLabel:string>?
< The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)approvalDate:date>?
< The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. If specified, this date follows the original approval date.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)lastReviewDate:date>?
< The period during which the plan definition content was or is planned to be in active use. The effective period for a plan definition determines when the content is applicable for usage and is independent of publication and review dates. For example, a plan definition intended to be used for the year 2016 might be published in 2015.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)effectivePeriod:Period>?
[]< Descriptive topics related to the content of the plan definition. Topics provide a high-level categorization of the definition that can be useful for filtering and searching. DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'topic' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#topic and useContext.valueCodeableConcept indicating the topic) Binding: definition-topic (example, High-level categorization of the definition, used for searching, sorting, and filtering.); (xsd)topic:CodeableConcept>*
[]< An individiual or organization primarily involved in the creation and maintenance of the content.; (xsd)author:ContactDetail>*
[]< An individual or organization primarily responsible for internal coherence of the content.; (xsd)editor:ContactDetail>*
[]< An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the content. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)reviewer:ContactDetail>*
[]< An individual or organization asserted by the publisher to be responsible for officially endorsing the content for use in some setting. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)endorser:ContactDetail>*
[]< Related artifacts such as additional documentation, justification, or bibliographic references. Each related artifact is either an attachment, or a reference to another resource, but not both.; (xsd)relatedArtifact:RelatedArtifact>*
< A reference to a Library resource containing any formal logic used by the plan definition.; (xsd)library:Library*>
[]< A goal describes an expected outcome that activities within the plan are intended to achieve. For example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, meeting the acceptance criteria for a test as specified by a quality specification, etc.; (xsd)goal:computableplandefinition.goal>*
[]< Actors represent the individuals or groups involved in the execution of the defined set of activities.; (xsd)actor:computableplandefinition.actor>*
[]< An action or group of actions to be taken as part of the plan. For example, in clinical care, an action would be to prescribe a particular indicated medication, or perform a particular test as appropriate. In pharmaceutical quality, an action would be the test that needs to be performed on a drug product as defined in the quality specification. Note that there is overlap between many of the elements defined here and the ActivityDefinition resource. When an ActivityDefinition is referenced (using the definition element), the overlapping elements in the plan override the content of the referenced ActivityDefinition unless otherwise documented in the specific elements. See the PlanDefinition resource for more detailed information.; (xsd)action:computableplandefinition.action>*
< If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example "pain", "on flare-up", etc. Binding: medication-as-needed-reason (example, A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc.); (xsd)asNeeded:(<boolean>
|<CodeableConcept>)>?🔗 An action or group of actions to be taken as part of the plan. For example, in clinical care, an action would be to prescribe a particular indicated medication, or perform a particular test as appropriate. In pharmaceutical quality, an action would be the test that needs to be performed on a drug product as defined in the quality specification. Note that there is overlap between many of the elements defined here and the ActivityDefinition resource. When an ActivityDefinition is referenced (using the definition element), the overlapping elements in the plan override the content of the referenced ActivityDefinition unless otherwise documented in the specific elements. See the PlanDefinition resource for more detailed information.computableplandefinition.action(xsd)(doc)=
<#base:PlanDefinition.action>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< An identifier that is unique within the PlanDefinition to allow linkage within the realized CarePlan and/or RequestOrchestration.; (xsd)linkId:string>?
< A user-visible prefix for the action. For example a section or item numbering such as 1. or A.; (xsd)prefix:string>?
< The textual description of the action displayed to a user. For example, when the action is a test to be performed, the title would be the title of the test such as Assay by HPLC.; (xsd)title:string>?
< A brief description of the action used to provide a summary to display to the user.; (xsd)description:markdown>?
< A text equivalent of the action to be performed. This provides a human-interpretable description of the action when the definition is consumed by a system that might not be capable of interpreting it dynamically.; (xsd)textEquivalent:markdown>?
< Indicates how quickly the action should be addressed with respect to other actions. Binding: request-priority (required, Identifies the level of importance to be assigned to actioning the request.); (xsd)priority:code>?
< A code that provides a meaning, grouping, or classification for the action or action group. For example, a section may have a LOINC code for the section of a documentation template. In pharmaceutical quality, an action (Test) such as pH could be classified as a physical property. Binding: action-code (example, Provides examples of actions to be performed.); (xsd)code:CodeableConcept>?
[]< A description of why this action is necessary or appropriate. This is different than the clinical evidence documentation, it's an actual business description of the reason for performing the action. Binding: action-reason-code (example, Provides examples of reasons for actions to be performed.); (xsd)reason:CodeableConcept>*
[]< Didactic or other informational resources associated with the action that can be provided to the CDS recipient. Information resources can include inline text commentary and links to web resources.; (xsd)documentation:RelatedArtifact>*
[]< Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition. In pharmaceutical quality, a goal represents acceptance criteria (Goal) for a given action (Test), so the goalId would be the unique id of a defined goal element establishing the acceptance criteria for the action.; (xsd)goalId:id>*
< A code, group definition, or canonical reference that describes the intended subject of the action and its children, if any. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource. The subject of an action overrides the subject at a parent action or on the root of the PlanDefinition if specified.
In addition, because the subject needs to be resolved during realization, use of subjects in actions (or in the ActivityDefinition referenced by the action) resolves based on the set of subjects supplied in context and by type (i.e. the patient subject would resolve to a resource of type Patient). Binding: participant-resource-types (extensible, The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).); (xsd)subject:(<CodeableConcept>
|<Group>
|<Resource>)>?
[]< A description of when the action should be triggered. When multiple triggers are specified on an action, any triggering event invokes the action.; (xsd)trigger:TriggerDefinition>*
[]< An expression that describes applicability criteria or start/stop conditions for the action. When multiple conditions of the same kind are present, the effects are combined using AND semantics, so the overall condition is true only if all the conditions are true.; (xsd)condition:computableplandefinition.action.condition>*
[]< Defines input data requirements for the action.; (xsd)input:computableplandefinition.action.input>*
[]< Defines the outputs of the action, if any.; (xsd)output:computableplandefinition.action.output>*
[]< A relationship to another action such as "before" or "30-60 minutes after start of". When an action depends on multiple actions, the meaning is that all actions are dependencies, rather than that any of the actions are a dependency.; (xsd)relatedAction:computableplandefinition.action.relatedAction>*
< An optional value describing when the action should be performed. The intent of the timing element is to provide timing when the action should be performed. As a definitional resource, this timing is interpreted as part of an apply operation so that the timing of the result actions in a CarePlan or RequestOrchestration, for example, would be specified by evaluating the timing definition in the context of the apply and setting the resulting timing on the appropriate elements of the target resource. If the timing is an Age, the activity is expected to be performed when the subject is the given Age. When the timing is a Duration, the activity is expected to be performed within the specified duration from the apply. When the timing is a Range, it may be a range of Ages or Durations, providing a range for the expected timing of the resulting activity. When the timing is a Timing, it is establishing a schedule for the timing of the resulting activity.; (xsd)timing:(<Age>
|<Duration>
|<Range>
|<Timing>)>?
< Identifies the facility where the action will occur; e.g. home, hospital, specific clinic, etc. May reference a specific clinical location or may just identify a type of location.; (xsd)location:Location*>?
[]< Indicates who should participate in performing the action described.; (xsd)participant:computableplandefinition.action.participant>*
< The type of action to perform (create, update, remove). Binding: action-type (extensible, The type of action to be performed.); (xsd)type:CodeableConcept>?
< Defines the grouping behavior for the action and its children. Binding: action-grouping-behavior (required, Defines organization behavior of a group.); (xsd)groupingBehavior:code>?
< Defines the selection behavior for the action and its children. Binding: action-selection-behavior (required, Defines selection behavior of a group.); (xsd)selectionBehavior:code>?
< Defines the required behavior for the action. Binding: action-required-behavior (required, Defines expectations around whether an action or action group is required.); (xsd)requiredBehavior:code>?
< Defines whether the action should usually be preselected. Binding: action-precheck-behavior (required, Defines selection frequency behavior for an action or group.); (xsd)precheckBehavior:code>?
< Defines whether the action can be selected multiple times. Binding: action-cardinality-behavior (required, Defines behavior for an action or a group for how many times that item may be repeated.); (xsd)cardinalityBehavior:code>?
< A reference to an ActivityDefinition that describes the action to be taken in detail, a MessageDefinition describing a message to be snet, a PlanDefinition that describes a series of actions to be taken, a Questionnaire that should be filled out, a SpecimenDefinition describing a specimen to be collected, or an ObservationDefinition that specifies what observation should be captured. Note that the definition is optional, and if no definition is specified, a dynamicValue with a root ($this) path can be used to define the entire resource dynamically.; (xsd)definition:(<ActivityDefinition>
|<MessageDefinition>
|<ObservationDefinition>
|<PlanDefinition>
|<Questionnaire>
|<SpecimenDefinition>
|<uri>)>?
< A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input. Note that when a referenced ActivityDefinition also defines a transform, the transform specified here generally takes precedence. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.; (xsd)transform:StructureMap*>?
[]< Customizations that should be applied to the statically defined resource. For example, if the dosage of a medication must be computed based on the patient's weight, a customization would be used to specify an expression that calculated the weight, and the path on the resource that would contain the result. Dynamic values are applied in the order in which they are defined in the PlanDefinition resource. Note that when dynamic values are also specified by a referenced ActivityDefinition, the dynamicValues from the ActivityDefinition are applied first, followed by the dynamicValues specified here. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.; (xsd)dynamicValue:computableplandefinition.action.dynamicValue>*
[]< Sub actions that are contained within the action. The behavior of this action determines the functionality of the sub-actions. For example, a selection behavior of at-most-one indicates that of the sub-actions, at most one may be chosen as part of realizing the action definition.; (xsd)action:PlanDefinition.action>*🔗 An expression that describes applicability criteria or start/stop conditions for the action. When multiple conditions of the same kind are present, the effects are combined using AND semantics, so the overall condition is true only if all the conditions are true.computableplandefinition.action.condition(xsd)(doc)=
<#base:PlanDefinition.action.condition>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The kind of condition. Applicability criteria are used to determine immediate applicability when a plan definition is applied to a given context. Start and stop criteria are carried through application and used to describe enter/exit criteria for an action. Binding: action-condition-kind (required, Defines the kinds of conditions that can appear on actions.); (xsd)kind:code>
< An expression that returns true or false, indicating whether the condition is satisfied. The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.; (xsd)expression:Expression>?🔗 Customizations that should be applied to the statically defined resource. For example, if the dosage of a medication must be computed based on the patient's weight, a customization would be used to specify an expression that calculated the weight, and the path on the resource that would contain the result. Dynamic values are applied in the order in which they are defined in the PlanDefinition resource. Note that when dynamic values are also specified by a referenced ActivityDefinition, the dynamicValues from the ActivityDefinition are applied first, followed by the dynamicValues specified here. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.computableplandefinition.action.dynamicValue(xsd)(doc)=
<#base:PlanDefinition.action.dynamicValue>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The path to the element to be customized. This is the path on the resource that will hold the result of the calculation defined by the expression. The specified path SHALL be a FHIRPath resolvable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. 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). To specify the path to the current action being realized, the %action environment variable is available in this path. For example, to specify the description element of the target action, the path would be %action.description. The path attribute contains a [Simple FHIRPath Subset](fhirpath.html#simple) that allows path traversal, but not calculation.; (xsd)path:string>?
< An expression specifying the value of the customized element. The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.; (xsd)expression:Expression>?🔗 Defines input data requirements for the action.computableplandefinition.action.input(xsd)(doc)=
<#base:PlanDefinition.action.input>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A human-readable label for the data requirement used to label data flows in BPMN or similar diagrams. Also provides a human readable label when rendering the data requirement that conveys its purpose to human readers.; (xsd)title:string>?
< Defines the data that is to be provided as input to the action.; (xsd)requirement:DataRequirement>?
< Points to an existing input or output element that provides data to this input. The relatedData element allows indicating that an input to a parent action is an input to specific child actions. It also allows the output of one action to be identified as the input to a different action; (xsd)relatedData:id>?🔗 Defines the outputs of the action, if any.computableplandefinition.action.output(xsd)(doc)=
<#base:PlanDefinition.action.output>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A human-readable label for the data requirement used to label data flows in BPMN or similar diagrams. Also provides a human readable label when rendering the data requirement that conveys its purpose to human readers.; (xsd)title:string>?
< Defines the data that results as output from the action.; (xsd)requirement:DataRequirement>?
< Points to an existing input or output element that is results as output from the action. The relatedData element allows indicating that the output of child action is also the output of a parent action. It also allows the input of one action to be identified as the output of a different action; (xsd)relatedData:string>?🔗 Indicates who should participate in performing the action described.computableplandefinition.action.participant(xsd)(doc)=
<#base:PlanDefinition.action.participant>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A reference to the id element of the actor who will participate in this action.; (xsd)actorId:string>?
< The type of participant in the action. Binding: action-participant-type (required, The type of participant in the activity.); (xsd)type:code>?
< The type of participant in the action.; (xsd)typeCanonical:CapabilityStatement*>?
< The type of participant in the action. When this element is a reference, it SHOULD be a reference to a definitional resource (for example, a location type, rather than a specific location).; (xsd)typeReference:(<CareTeam>
|<Device>
|<DeviceDefinition>
|<Endpoint>
|<Group>
|<HealthcareService>
|<Location>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>?
< The role the participant should play in performing the described action. Binding: http://terminology.hl7.org/ValueSet/action-participant-role (example, Defines roles played by participants for the action.); (xsd)role:CodeableConcept>?
< Indicates how the actor will be involved in the action - author, reviewer, witness, etc. Binding: action-participant-function (example, ); (xsd)function:CodeableConcept>?🔗 A relationship to another action such as "before" or "30-60 minutes after start of". When an action depends on multiple actions, the meaning is that all actions are dependencies, rather than that any of the actions are a dependency.computableplandefinition.action.relatedAction(xsd)(doc)=
<#base:PlanDefinition.action.relatedAction>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The element id of the target related action.; (xsd)targetId:id>
< The relationship of the start of this action to the related action. Binding: action-relationship-type (required, Defines the types of relationships between actions.); (xsd)relationship:code>
< The relationship of the end of this action to the related action. Binding: action-relationship-type (required, Defines the types of relationships between actions.); (xsd)endRelationship:code>?
< A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.; (xsd)offset:(<Duration>
|<Range>)>?🔗 Actors represent the individuals or groups involved in the execution of the defined set of activities.computableplandefinition.actor(xsd)(doc)=
<#base:PlanDefinition.actor>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A descriptive label for the actor.; (xsd)title:string>?
< A description of how the actor fits into the overall actions of the plan definition.; (xsd)description:markdown>?
[]< The characteristics of the candidates that could serve as the actor.; (xsd)option:computableplandefinition.actor.option>+🔗 The characteristics of the candidates that could serve as the actor.computableplandefinition.actor.option(xsd)(doc)=
<#base:PlanDefinition.actor.option>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The type of participant in the action. Binding: action-participant-type (required, The type of participant in the activity.); (xsd)type:code>?
< The type of participant in the action.; (xsd)typeCanonical:CapabilityStatement*>?
< The type of participant in the action. When this element is a reference, it SHOULD be a reference to a definitional resource (for example, a location type, rather than a specific location).; (xsd)typeReference:(<CareTeam>
|<Device>
|<DeviceDefinition>
|<Endpoint>
|<Group>
|<HealthcareService>
|<Location>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>?
< The role the participant should play in performing the described action. Binding: http://terminology.hl7.org/ValueSet/action-participant-role (example, ); (xsd)role:CodeableConcept>?🔗 A goal describes an expected outcome that activities within the plan are intended to achieve. For example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, meeting the acceptance criteria for a test as specified by a quality specification, etc.computableplandefinition.goal(xsd)(doc)=
<#base:PlanDefinition.goal>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Indicates a category the goal falls within. Binding: goal-category (example, Example codes for grouping goals for filtering or presentation.); (xsd)category:CodeableConcept>?
< Human-readable and/or coded description of a specific desired objective of care, such as "control blood pressure" or "negotiate an obstacle course" or "dance with child at wedding". If no code is available, use CodeableConcept.text. Binding: clinical-findings (example, Describes goals that can be achieved.); (xsd)description:CodeableConcept>
< Identifies the expected level of importance associated with reaching/sustaining the defined goal. Binding: goal-priority (preferred, Indicates the level of importance associated with reaching or sustaining a goal.); (xsd)priority:CodeableConcept>?
< The event after which the goal should begin being pursued. Binding: goal-start-event (example, Identifies the types of events that might trigger the start of a goal.); (xsd)start:CodeableConcept>?
[]< Identifies problems, conditions, issues, or concerns the goal is intended to address. Binding: condition-code (example, Identifies problems, conditions, issues, or concerns that goals may address.); (xsd)addresses:CodeableConcept>*
[]< Didactic or other informational resources associated with the goal that provide further supporting information about the goal. Information resources can include inline text commentary and links to web resources.; (xsd)documentation:RelatedArtifact>*
[]< Indicates what should be done and within what timeframe.; (xsd)target:computableplandefinition.goal.target>*🔗 Indicates what should be done and within what timeframe.computableplandefinition.goal.target(xsd)(doc)=
<#base:PlanDefinition.goal.target>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The parameter whose value is to be tracked, e.g. body weight, blood pressure, or hemoglobin A1c level. Binding: observation-codes (example, Identifies types of parameters that can be tracked to determine goal achievement.); (xsd)measure:CodeableConcept>?
< The target value of the measure to be achieved to signify fulfillment of the goal, e.g. 150 pounds or 7.0%, or in the case of pharmaceutical quality - NMT 0.6%, Clear solution, etc. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any value at or above the low value. A CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the goal.target.measure defines a coded value.; (xsd)detail:(<boolean>
|<CodeableConcept>
|<integer>
|<Quantity>
|<Range>
|<Ratio>
|<string>)>?
< Indicates the timeframe after the start of the goal in which the goal should be met.; (xsd)due:Duration>?🔗 A value set that includes instructions for construction of the value set using one and only one of human instructions, machine instructions, or the value set compose element.computablevalueset(xsd)(doc)=
<#base:shareablevalueset>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< An Extension; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< An absolute URI that is used to identify this value set when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this value set is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the value set is stored on different servers. Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.
The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions).
In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.; (xsd)url:uri>
[]< A formal identifier that is used to identify this value set when it is represented in other formats, or referenced in a specification, model, design or an instance. Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this value set outside of FHIR, where it is not possible to use the logical URI.; (xsd)identifier:Identifier>*
< The identifier that is used to identify this version of the value set when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the value set author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. There may be different value set instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the value set with the format [url]|[version]. The version SHOULD NOT contain a '#' - see [Business Version](resource.html#bv-format).; (xsd)version:string>
< Indicates the mechanism used to compare versions to determine which ValueSet is more current. If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined. Binding: version-algorithm (extensible, ); (xsd)versionAlgorithm:(<Coding>
|<string>)>?
< A natural language name identifying the value set. This name should be usable as an identifier for the module by machine processing applications such as code generation. The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.A name should be provided unless the value set is a contained resource (e.g. an anonymous value set in a profile). Most registries will require a name.; (xsd)name:string>?
< A short, descriptive, user-friendly title for the value set. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.; (xsd)title:string>
< The status of this value set. Enables tracking the life-cycle of the content. The status of the value set applies to the value set definition (ValueSet.compose) and the associated ValueSet metadata. Expansions do not have a state. Allows filtering of value sets that are appropriate for use versus not.See also the [http://hl7.org/fhir/StructureDefinition/valueset-workflowStatusDescription](http://hl7.org/fhir/extensions/StructureDefinition-valueset-workflowStatusDescription.html) extension for additional status information related to the editorial process.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization). Binding: publication-status (required, The lifecycle status of an artifact.); (xsd)status:code>
< A Boolean value to indicate that this value set is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. Allows filtering of value sets that are appropriate for use versus not.; (xsd)experimental:boolean>
< The date (and optionally time) when the value set metadata or content logical definition (.compose) was created or revised. Note that this is not the same as the meta.lastUpdated which is specific to an instance of a value set resource on a server. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)date:dateTime>?
< The name of the organization or individual responsible for the release and ongoing maintenance of the value set. Usually an organization but may be an individual. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the value set. This item SHOULD be populated unless the information is available from context.; (xsd)publisher:string>?
[]< Contact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)contact:ContactDetail>*
< A free text natural language description of the value set from a consumer's perspective. The textual description specifies the span of meanings for concepts to be included within the Value Set Expansion, and also may specify the intended use and limitations of the Value Set. Description SHOULD contain instructions for clinical or administrative use and interpretation and information about misuse. Description SHOULD be populated unless the information is available from context. Description SHOULD be populated unless the value set is a contained resource (e.g. a value set defined solely in the context of a profile).; (xsd)description:markdown>
[]< The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate value set instances. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.; (xsd)useContext:UsageContext>*
[]< A legal or geographic region in which the value set is intended to be used. It may be possible for the value set to be used in jurisdictions other than those for which it was originally designed or intended.
DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.) Binding: jurisdiction (extensible, Countries and regions within which this artifact is targeted for use.); (xsd)jurisdiction:CodeableConcept>*
< If this is set to 'true', then no new versions of the content logical definition can be created. Note: Other metadata might still change. Normally immutability is set to 'false', which is the default assumption if it is not populated. Note that the implication is that if this is set to 'true', there may be only one ValueSet version for this definition. Immutability tends to be set to 'true' in one of two cases: - Where the value set, by the nature of its usage, cannot change. For example "All specializations of ACT in ActClassCode" - Where there's no safe way to express the "Purpose" such that someone else could safely make changes to the value set definition. Source workflow control must guarantee that the same URI always yields the same definition.; (xsd)immutable:boolean>?
< Explanation of why this value set is needed and why it has been designed as it has. This element does not describe the usage of the value set. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this value set.; (xsd)purpose:markdown>?
< A copyright statement relating to the value set and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the value set. Frequently, the copyright differs between the value set and the codes that are included. The copyright statement should clearly differentiate between these when required.; (xsd)copyright:markdown>?
< A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved'). The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.; (xsd)copyrightLabel:string>?
< The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)approvalDate:date>?
< The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. If specified, this date follows the original approval date.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)lastReviewDate:date>?
< The period during which the ValueSet content was or is planned to be in active use. The effective period for a ValueSet determines when the content is applicable for usage and is independent of publication and review dates. For example, a valueset intended to be used for the year 2016 might be published in 2015.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)effectivePeriod:Period>?
[]< Descriptions related to the content of the ValueSet. Topics provide a high-level categorization as well as keywords for the ValueSet that can be useful for filtering and searching. DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'topic' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#topic and useContext.valueCodeableConcept indicating the topic) Binding: definition-topic (example, ); (xsd)topic:CodeableConcept>*
[]< An individiual or organization primarily involved in the creation and maintenance of the ValueSet.; (xsd)author:ContactDetail>*
[]< An individual or organization primarily responsible for internal coherence of the ValueSet.; (xsd)editor:ContactDetail>*
[]< An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the ValueSet. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)reviewer:ContactDetail>*
[]< An individual or organization asserted by the publisher to be responsible for officially endorsing the ValueSet for use in some setting. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)endorser:ContactDetail>*
[]< Related artifacts such as additional documentation, justification, dependencies, bibliographic references, and predecessor and successor artifacts. Each related artifact is either an attachment, or a reference to another resource, but not both.; (xsd)relatedArtifact:RelatedArtifact>*
< A set of criteria that define the contents of the value set by including or excluding codes selected from the specified code system(s) that the value set draws from. This is also known as the Content Logical Definition (CLD).; (xsd)compose:computablevalueset.compose>?
< A value set can also be "expanded", where the value set is turned into a simple collection of enumerated codes. This element holds the expansion, if it has been performed. Expansion is performed to produce a collection of codes that are ready to use for data entry or validation. Value set expansions are always considered to be stateless - they are a record of the set of codes in the value set at a point in time under a given set of conditions, and are not subject to ongoing maintenance.
Expansion.parameter is a simplified list of parameters - a subset of the features of the [Parameters](parameters.html) resource.; (xsd)expansion:computablevalueset.expansion>?
< Description of the semantic space the Value Set Expansion is intended to cover and should further clarify the text in ValueSet.description.; (xsd)scope:computablevalueset.scope>?
[]< Defines a knowledge representation level provided by this knowledge artifact.; (xsd)knowledgeRepresentationLevel:Extension>*
< A reference to the authoritative accessible, persisted source of truth of the entire Value Set Definition, including textual information and available versions. If this extension is not present, then the canonical URL (ValueSet.url) also serves the purpose of specifying the authoritative source. A difference between the canonical URL and the authoritiative source might arise in some cases due to ongoing organization restructuring, etc., and in those cases this extension may be used. The URL of the authoritative source is intended to be resolvable but that cannot be guaranteed. The designated "authoritative source" is normally expected to be able to generate a valid expansion of the value set, and if for some reason it cannot then the valueset-trusted-expansion should be used.; (xsd)authoritativeSource:Extension>?
< An expression that provides a definition of the content of the value set in some form that is not computable - e.g. instructions that could only be followed by a human. Only one of rulesText, expression, or compose SHALL be provided for any given value set instance. Note that to provide a human-readable description of the expression, use the description element of the expression datatype.; (xsd)rulesText:Extension>?
< An expression that provides the computable definition for the content of the value set. The value set can only be expanded by a server that understands the expression syntax used. Only one of rulesText, expression, or compose SHALL be provided for any given value set instance. Note that to provide a human-readable description of the expression, use the description element of the expression datatype.; (xsd)expression:Extension>?
< This extension declares that a value set depends on a particular [CodeSystem supplement](codesystem.html#supplements) and should not be used in its absence.; (xsd)supplement:Extension>?🔗 A set of criteria that define the contents of the value set by including or excluding codes selected from the specified code system(s) that the value set draws from. This is also known as the Content Logical Definition (CLD).computablevalueset.compose(xsd)(doc)=
<#base:ValueSet.compose>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The Locked Date is the effective date that is used to determine the version of all referenced Code Systems and Value Set Definitions included in the compose that are not already tied to a specific version. With a defined lockedDate the value set is considered "Locked". Otherwise, the value set may have different expansions as underlying code systems and/or value sets evolve. The interpretation of lockedDate is often dependent on the context - e.g. a SNOMED CT derived value set with a lockedDate will have a different expansion in USA than in UK. If a value set specifies a version for include and exclude statements, and also specifies a locked date, the specified versions need to be available that date, or the value set will not be usable.; (xsd)lockedDate:date>?
< Whether inactive codes - codes that are not approved for current use - are in the value set. If inactive = true, inactive codes are to be included in the expansion, if inactive = false, the inactive codes will not be included in the expansion. If absent, the behavior is determined by the implementation, or by the applicable $expand parameters (but generally, inactive codes would be expected to be included). Note that in the FHIR terminology framework, "deprecated" does not mean inactive, but in some code systems, e.g. LOINC, "deprecated" does mean inactive. Code systems should define what codes are considered to be inactive. If this is not clearly defined (including in the FHIR code system resource), then all codes are assumed to be active.
The Value Set Definition specification defines an ActiveOnly element, which is the reverse of this element e.g. (ValueSet.compose.inactive=FALSE) is the same as (VSD.ActiveOnly=TRUE).; (xsd)inactive:boolean>?
[]< Include one or more codes from a code system or other value set(s). All the conditions in an include must be true. If a system is listed, all the codes from the system are listed. If one or more filters are listed, all of the filters must apply. If one or more value sets are listed, the codes must be in all the value sets. E.g. each include is 'include all the codes that meet all these conditions'.; (xsd)include:computablevalueset.compose.include>+
[]< Exclude one or more codes from the value set based on code system filters and/or other value sets. Usually this is used to selectively exclude codes that were included by subsumption in the inclusions. Any display names specified for the codes are ignored.; (xsd)exclude:ValueSet.compose.include>*
[]< A property to return in the expansion, if the client doesn't ask for any particular properties. May be either a code from the code system definition (convenient) or a the formal URI that refers to the property. The special value '*' means all properties known to the server. Note that property names can clash, so using a URI is recommended.; (xsd)property:string>*🔗 Include one or more codes from a code system or other value set(s). All the conditions in an include must be true. If a system is listed, all the codes from the system are listed. If one or more filters are listed, all of the filters must apply. If one or more value sets are listed, the codes must be in all the value sets. E.g. each include is 'include all the codes that meet all these conditions'.computablevalueset.compose.include(xsd)(doc)=
<#base:ValueSet.compose.include>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< An absolute URI which is the code system from which the selected codes come from. If there are no codes or filters, the entire code system is included. Note that the set of codes that are included may contain abstract codes. See ''Coding.system'' for further documentation about the correct value for the system element.; (xsd)system:uri>?
< The version of the code system that the codes are selected from, or the special version '*' for all versions. This is used when selecting the descendants of a concept - they may change between versions. If no version is specified, then the exact contents of the value set might not be known until a context of use binds it to a particular version. The special value '*' means all versions; It is at server discretion regarding expansions and which versions must be supported.; (xsd)version:string>?
[]< Specifies a concept to be included or excluded. The list of concepts is considered ordered, though the order might not have any particular significance. Typically, the order of an expansion follows that defined in the compose element.; (xsd)concept:computablevalueset.compose.include.concept>*
[]< Select concepts by specifying a matching criterion based on the properties (including relationships) defined by the system, or on filters defined by the system. If multiple filters are specified within the include, they SHALL all be true. Selecting codes by specifying filters based on properties is only possible where the underlying code system defines appropriate properties. Note that in some cases, the underlying code system defines the logical concepts but not the literal codes for the concepts. In such cases, the literal definitions may be provided by a third party.; (xsd)filter:computablevalueset.compose.include.filter>*
[]< Selects the concepts found in this value set (based on its value set definition). This is an absolute URI that is a reference to ValueSet.url. If multiple value sets are specified this includes the intersection of the contents of all of the referenced value sets. The value set URI is either a logical reference to a defined value set such as a [SNOMED CT reference set](https://terminology.hl7.org/SNOMEDCT.html), or a direct reference to a value set definition using ValueSet.url. The reference might not refer to an actual FHIR ValueSet resource; in this case, whatever is referred to is an implicit definition of a value set that needs to be clear about how versions are resolved.; (xsd)valueSet:ValueSet*>*
< A copyright statement for the specific code system asserted by the containing ValueSet.compose.include element's system value (if the associated ValueSet.compose.include.version element is not present); or the code system and version combination (if the associated ValueSet.compose.include.version element is present).; (xsd)copyright:string>?🔗 Specifies a concept to be included or excluded. The list of concepts is considered ordered, though the order might not have any particular significance. Typically, the order of an expansion follows that defined in the compose element.computablevalueset.compose.include.concept(xsd)(doc)=
<#base:ValueSet.compose.include.concept>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Specifies a code for the concept to be included or excluded. Expressions are allowed if defined by the underlying code system.; (xsd)code>
< The text to display to the user for this concept in the context of this valueset. If no display is provided, then applications using the value set use the display specified for the code by the system. The value set resource allows for an alternative display to be specified for when this concept is used in this particular value set. See notes in the value set narrative about the correct use of this element.; (xsd)display:string>?
[]< Additional representations for this concept when used in this value set - other languages, aliases, specialized purposes, used for particular purposes, etc. Concepts have both a ```display``` and an array of ```designation```. The display is equivalent to a special designation with an implied ```designation.use``` of "primary code" and a language equal to the [Resource Language](resource.html#language).; (xsd)designation:computablevalueset.compose.include.concept.designation>*🔗 Additional representations for this concept when used in this value set - other languages, aliases, specialized purposes, used for particular purposes, etc. Concepts have both a ```display``` and an array of ```designation```. The display is equivalent to a special designation with an implied ```designation.use``` of "primary code" and a language equal to the [Resource Language](resource.html#language).computablevalueset.compose.include.concept.designation(xsd)(doc)=
<#base:ValueSet.compose.include.concept.designation>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The language this designation is defined for. In the absence of a language, the resource language applies. Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< A code that represents types of uses of designations. If no use is provided, the designation can be assumed to be suitable for general display to a human user. Binding: designation-use (extensible, Details of how a designation would be used.); (xsd)use:Coding>?
[]< Additional codes that detail how this designation would be used, if there is more than one use. This was added rather than increasing the cardinality of .use to 0..* in order to maintain backward compatibility. Binding: designation-use (extensible, Details of how a designation would be used.); (xsd)additionalUse:Coding>*
< The text value for this designation.; (xsd)value:string>🔗 Select concepts by specifying a matching criterion based on the properties (including relationships) defined by the system, or on filters defined by the system. If multiple filters are specified within the include, they SHALL all be true. Selecting codes by specifying filters based on properties is only possible where the underlying code system defines appropriate properties. Note that in some cases, the underlying code system defines the logical concepts but not the literal codes for the concepts. In such cases, the literal definitions may be provided by a third party.computablevalueset.compose.include.filter(xsd)(doc)=
<#base:ValueSet.compose.include.filter>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A code that identifies a property or a filter defined in the code system.; (xsd)property:code>
< The kind of operation to perform as a part of the filter criteria. In case filter.property represents a property of the system, the operation applies to the selected property. In case filter.property represents a filter of the system, the operation SHALL match one of the CodeSystem.filter.operator values. Binding: filter-operator (required, The kind of operation to perform as a part of a property based filter.); (xsd)op:code>
< The match value may be either a code defined by the system, or a string value, which is a regex match on the literal string of the property value (if the filter represents a property defined in CodeSystem) or of the system filter value (if the filter represents a filter defined in CodeSystem) when the operation is 'regex', or one of the values (true and false), when the operation is 'exists'. Use regex matching with care - full regex matching on every SNOMED CT term is prohibitive, for example.; (xsd)value:string>🔗 A value set can also be "expanded", where the value set is turned into a simple collection of enumerated codes. This element holds the expansion, if it has been performed. Expansion is performed to produce a collection of codes that are ready to use for data entry or validation. Value set expansions are always considered to be stateless - they are a record of the set of codes in the value set at a point in time under a given set of conditions, and are not subject to ongoing maintenance.
Expansion.parameter is a simplified list of parameters - a subset of the features of the [Parameters](parameters.html) resource.computablevalueset.expansion(xsd)(doc)=
<#base:ValueSet.expansion>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< An identifier that uniquely identifies this expansion of the valueset, based on a unique combination of the provided parameters, the system default parameters, and the underlying system code system versions etc. Systems may re-use the same identifier as long as those factors remain the same, and the expansion is the same, but are not required to do so. This is a business identifier. Typically, this uri is a UUID (e.g. urn:uuid:8230ff20-c97a-4167-a59d-dc2cb9df16dd).; (xsd)identifier:uri>?
< As per paging Search results, the next URLs are opaque to the client, have no dictated structure, and only the server understands them. Clients SHOULD use the next link, if present, to page through expansion results in preference to using the offset and count parameters. Due to the optional nature of the next link, its absence does not necessarily indicate that it is the last page of results. Instead, as the offset and count parameters SHALL be populated when paging, clients can reliably use the count/offset parameters to determine whether the whole expansion is returned.; (xsd)next:uri>?
< The time at which the expansion was produced by the expanding system. This SHOULD be a fully populated instant, but in some circumstances, value sets are expanded by hand, and the expansion is published without that precision.; (xsd)timestamp:dateTime>
< The total number of concepts in the expansion. If the number of concept nodes in this resource is less than the stated number, then the server can return more using the offset parameter. Paging only applies to flat expansions.; (xsd)total:integer>?
< If paging is being used, the offset at which this resource starts. I.e. this resource is a partial view into the expansion. If paging is not being used, this element SHALL NOT be present. Paging only applies to flat expansions. If a filter is applied, the count is the number of concepts that matched the filter, not the number of concepts in an unfiltered view of the expansion.; (xsd)offset:integer>?
[]< A parameter that controlled the expansion process. These parameters may be used by users of expanded value sets to check whether the expansion is suitable for a particular purpose, or to pick the correct expansion. The server decides which parameters to include here, but at a minimum, the list SHOULD include all of the parameters that affect the $expand operation. If the expansion will be persisted all of these parameters SHALL be included. If the codeSystem on the server has a specified version then this version SHALL be provided as a parameter in the expansion (note that not all code systems have a version).; (xsd)parameter:computablevalueset.expansion.parameter>*
[]< A property defines an additional slot through which additional information can be provided about a concept.; (xsd)property:computablevalueset.expansion.property>*
[]< The codes that are contained in the value set expansion.; (xsd)contains:computablevalueset.expansion.contains>*🔗 The codes that are contained in the value set expansion.computablevalueset.expansion.contains(xsd)(doc)=
<#base:ValueSet.expansion.contains>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< An absolute URI which is the code system in which the code for this item in the expansion is defined.; (xsd)system:uri>?
< If true, this entry is included in the expansion for navigational purposes, and the user cannot select the code directly as a proper value. This should not be understood to exclude its use for searching (e.g. by subsumption testing). The client should know whether it is appropriate for the user to select an abstract code or not.; (xsd)abstract:boolean>?
< If the concept is inactive in the code system that defines it. Inactive codes are those that are no longer to be used, but are maintained by the code system for understanding legacy data. It might not be known or specified whether a concept is inactive (and it may depend on the context of use). This should only have a value if the concept is inactive.; (xsd)inactive:boolean>?
< The version of the code system from this code was taken. 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. The exact value of the version string is specified by the system from which the code is derived.; (xsd)version:string>?
< The code for this item in the expansion hierarchy. If this code is missing the entry in the hierarchy is a place holder (abstract) and does not represent a valid code in the value set.; (xsd)code>?
< The recommended display for this item in the expansion.; (xsd)display:string>?
[]< Additional representations for this item - other languages, aliases, specialized purposes, used for particular purposes, etc. These are relevant when the conditions of the expansion do not fix to a single correct representation. The designations provided must be based on the value set and code system definitions.; (xsd)designation:ValueSet.compose.include.concept.designation>*
[]< A property value for this concept.; (xsd)property:computablevalueset.expansion.contains.property>*
[]< Other codes and entries contained under this entry in the hierarchy. If the expansion uses this element, there is no implication about the logical relationship between them, and the structure cannot be used for logical inferencing. The structure exists to provide navigational assistance for helping human users to locate codes in the expansion.; (xsd)contains:ValueSet.expansion.contains>*🔗 A property value for this concept.computablevalueset.expansion.contains.property(xsd)(doc)=
<#base:ValueSet.expansion.contains.property>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A code that is a reference to ValueSet.expansion.property.code.; (xsd)code>
(<valueBoolean:boolean>
|<valueCode:code>
|<valueCoding:Coding>
|<valueDateTime:dateTime>
|<valueDecimal:decimal>
|<valueInteger:integer>
|<valueString:string>)
[]< A subproperty value for this concept.; (xsd)subProperty:computablevalueset.expansion.contains.property.subProperty>*🔗 A subproperty value for this concept.computablevalueset.expansion.contains.property.subProperty(xsd)(doc)=
<#base:ValueSet.expansion.contains.property.subProperty>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A code that is a reference to ValueSet.expansion.property.code.; (xsd)code>
(<valueBoolean:boolean>
|<valueCode:code>
|<valueCoding:Coding>
|<valueDateTime:dateTime>
|<valueDecimal:decimal>
|<valueInteger:integer>
|<valueString:string>)🔗 A parameter that controlled the expansion process. These parameters may be used by users of expanded value sets to check whether the expansion is suitable for a particular purpose, or to pick the correct expansion. The server decides which parameters to include here, but at a minimum, the list SHOULD include all of the parameters that affect the $expand operation. If the expansion will be persisted all of these parameters SHALL be included. If the codeSystem on the server has a specified version then this version SHALL be provided as a parameter in the expansion (note that not all code systems have a version).computablevalueset.expansion.parameter(xsd)(doc)=
<#base:ValueSet.expansion.parameter>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Name of the input parameter to the $expand operation; may be a server-assigned name for additional default or other server-supplied parameters used to control the expansion process. The names are assigned at the discretion of the server.; (xsd)name:string>
(<valueBoolean:boolean>
|<valueCode:code>
|<valueDateTime:dateTime>
|<valueDecimal:decimal>
|<valueInteger:integer>
|<valueString:string>
|<valueUri:uri>)?🔗 A property defines an additional slot through which additional information can be provided about a concept.computablevalueset.expansion.property(xsd)(doc)=
<#base:ValueSet.expansion.property>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A code that is used to identify the property. The code is used in ValueSet.expansion.contains.property.code.; (xsd)code>
< Reference to the formal meaning of the property. One possible source of meaning is the [Concept Properties](codesystem-concept-properties.html) code system.; (xsd)uri>?🔗 Description of the semantic space the Value Set Expansion is intended to cover and should further clarify the text in ValueSet.description.computablevalueset.scope(xsd)(doc)=
<#base:ValueSet.scope>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Criteria describing which concepts or codes should be included and why.; (xsd)inclusionCriteria:string>?
< Criteria describing which concepts or codes should be excluded and why.; (xsd)exclusionCriteria:string>?🔗 A statement of relationships from one set of concepts to one or more other concepts - either concepts in code systems, or data element/data element concepts, or classes in class models.ConceptMap(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< An absolute URI that is used to identify this concept map when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this concept map is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the concept map is stored on different servers. Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.
The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions).
In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.; (xsd)url:uri>?
[]< A formal identifier that is used to identify this concept map when it is represented in other formats, or referenced in a specification, model, design or an instance. Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this concept map outside of FHIR, where it is not possible to use the logical URI.; (xsd)identifier:Identifier>*
< The identifier that is used to identify this version of the concept map when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the concept map author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. There may be different concept map instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the concept map with the format [url]|[version]. The version SHOULD NOT contain a '#' - see [Business Version](resource.html#bv-format).; (xsd)version:string>?
< Indicates the mechanism used to compare versions to determine which ConceptMap is more current. If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined. Binding: version-algorithm (extensible, ); (xsd)versionAlgorithm:(<Coding>
|<string>)>?
< A natural language name identifying the concept map. This name should be usable as an identifier for the module by machine processing applications such as code generation. The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.; (xsd)name:string>?
< A short, descriptive, user-friendly title for the concept map. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.; (xsd)title:string>?
< The status of this concept map. Enables tracking the life-cycle of the content. Allows filtering of concept maps that are appropriate for use versus not.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization). Binding: publication-status (required, The lifecycle status of an artifact.); (xsd)status:code>
< A Boolean value to indicate that this concept map is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. Allows filtering of concept maps that are appropriate for use versus not.; (xsd)experimental:boolean>?
< The date (and optionally time) when the concept map was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the concept map changes. The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the concept map. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)date:dateTime>?
< The name of the organization or individual responsible for the release and ongoing maintenance of the concept map. Usually an organization but may be an individual. The publisher (or steward) of the concept map is the organization or individual primarily responsible for the maintenance and upkeep of the concept map. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the concept map. This item SHOULD be populated unless the information is available from context.; (xsd)publisher:string>?
[]< Contact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)contact:ContactDetail>*
< A free text natural language description of the concept map from a consumer's perspective. The description is not intended to describe the semantics of the concept map. The description should capture its intended use, which is needed for ensuring integrity for its use in models across future changes.; (xsd)description:markdown>?
[]< The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate concept map instances. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.; (xsd)useContext:UsageContext>*
[]< A legal or geographic region in which the concept map is intended to be used. It may be possible for the concept map to be used in jurisdictions other than those for which it was originally designed or intended.
DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.) Binding: jurisdiction (extensible, Countries and regions within which this artifact is targeted for use.); (xsd)jurisdiction:CodeableConcept>*
< Explanation of why this concept map is needed and why it has been designed as it has. This element does not describe the usage of the concept map. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this concept map.; (xsd)purpose:markdown>?
< A copyright statement relating to the concept map and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the concept map. Frequently the copyright differs between the concept map and codes that are included. The copyright statement should clearly differentiate between these when required.; (xsd)copyright:markdown>?
< A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved'). The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.; (xsd)copyrightLabel:string>?
< The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)approvalDate:date>?
< The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. If specified, this date follows the original approval date.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)lastReviewDate:date>?
< The period during which the ConceptMap content was or is planned to be in active use. The effective period for a ConceptMap determines when the content is applicable for usage and is independent of publication and review dates. For example, a map intended to be used for the year 2016 might be published in 2015.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)effectivePeriod:Period>?
[]< Descriptions related to the content of the ConceptMap. Topics provide a high-level categorization as well as keywords for the ConceptMap that can be useful for filtering and searching. DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'topic' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#topic and useContext.valueCodeableConcept indicating the topic) Binding: definition-topic (example, ); (xsd)topic:CodeableConcept>*
[]< An individiual or organization primarily involved in the creation and maintenance of the ConceptMap.; (xsd)author:ContactDetail>*
[]< An individual or organization primarily responsible for internal coherence of the ConceptMap.; (xsd)editor:ContactDetail>*
[]< An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the ConceptMap. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)reviewer:ContactDetail>*
[]< An individual or organization asserted by the publisher to be responsible for officially endorsing the ConceptMap for use in some setting. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)endorser:ContactDetail>*
[]< Related artifacts such as additional documentation, justification, dependencies, bibliographic references, and predecessor and successor artifacts. Each related artifact is either an attachment, or a reference to another resource, but not both.; (xsd)relatedArtifact:RelatedArtifact>*
[]< A property defines a slot through which additional information can be provided about a map from source -> target. Properties may be used to supply for example, mapping priority, provenance, presentation hints, flag as experimental, and additional documentation. Multiple occurrences of ConceptMap.group.element.target.property may occur for a ConceptMap.property where ConceptMap.group.element.target.property.code is the same and the values in ConceptMap.group.element.target.property.value differ.; (xsd)property:ConceptMap.property>*
[]< An additionalAttribute defines an additional data element found in the source or target data model where the data will come from or be mapped to. Some mappings are based on data in addition to the source data element, where codes in multiple fields are combined to a single field (or vice versa). Additional attributes are used to define additional data elements where mapping data can be found. For an example, see [Specimen Type v2 -> SNOMED CT Mapping(conceptmap-example-specimen-type.html); (xsd)additionalAttribute:ConceptMap.additionalAttribute>*
< Identifier for the source value set that contains the concepts that are being mapped and provides context for the mappings. Limits the scope of the map to source codes (ConceptMap.group.element code or valueSet) that are members of this value set. Should be a version specific reference. URIs SHOULD be absolute. If there is no sourceScope or targetScope value set, there is no specified context for the map (not recommended). The sourceScope value set may select codes from either an explicit (standard or local) or implicit code system.; (xsd)sourceScope:(<uri>
|<ValueSet>)>?
< Identifier for the target value set that provides important context about how the mapping choices are made. Limits the scope of the map to target codes (ConceptMap.group.element.target code or valueSet) that are members of this value set. Should be a version specific reference. URIs SHOULD be absolute. If there is no sourceScope or targetScope value set, there is no specified context for the map (not recommended). The targetScope value set may select codes from either an explicit (standard or local) or implicit code system.; (xsd)targetScope:(<uri>
|<ValueSet>)>?
[]< A group of mappings that all have the same source and target system.; (xsd)group:ConceptMap.group>*🔗 An additionalAttribute defines an additional data element found in the source or target data model where the data will come from or be mapped to. Some mappings are based on data in addition to the source data element, where codes in multiple fields are combined to a single field (or vice versa). Additional attributes are used to define additional data elements where mapping data can be found. For an example, see [Specimen Type v2 -> SNOMED CT Mapping(conceptmap-example-specimen-type.html)ConceptMap.additionalAttribute(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A code that is used to identify this additional data attribute. The code is used internally in ConceptMap.group.element.target.dependsOn.attribute and ConceptMap.group.element.target.product.attribute.; (xsd)code>
< Reference to the formal definition of the source/target data element. For elements defined by the FHIR specification, or using a FHIR logical model, the correct format is {canonical-url}#{element-id}.; (xsd)uri>?
< A description of the additional attribute and/or the data element it refers to - why it is defined, and how the value might be used in mappings, and a discussion of issues associated with the use of the data element.; (xsd)description:string>?
< The type of the source data contained in this concept map for this data element. When the source or target is not content defined by FHIR, some additional application logic might be required to map from the FHIR Datatype to the externally defined content Binding: conceptmap-attribute-type (required, The type of a mapping attribute value.); (xsd)type:code>🔗 A group of mappings that all have the same source and target system.ConceptMap.group(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< An absolute URI that identifies the source system where the concepts to be mapped are defined. This is not needed if the source value set is specified and it contains concepts from only a single system.; (xsd)source:CodeSystem*>?
< An absolute URI that identifies the target system that the concepts will be mapped to. This is not needed if the target value set is specified and it contains concepts from only a single system. The group target may also be omitted if all of the target element relationship values are 'not-related-to'.; (xsd)target:CodeSystem*>?
[]< Mappings for an individual concept in the source to one or more concepts in the target. Generally, the ideal is that there would only be one mapping for each concept in the source value set, but a given concept may be mapped multiple times with different comments or dependencies.; (xsd)element:ConceptMap.group.element>+
< What to do when there is no mapping to a target concept from the source concept and ConceptMap.group.element.noMap is not true. This provides the "default" to be applied when there is no target concept mapping specified or the expansion of ConceptMap.group.element.target.valueSet is empty. The 'unmapped' element is ignored if a code is specified to have relationship = not-related-to or if ConceptMap.group.element.noMap = true.; (xsd)unmapped:ConceptMap.group.unmapped>?🔗 Mappings for an individual concept in the source to one or more concepts in the target. Generally, the ideal is that there would only be one mapping for each concept in the source value set, but a given concept may be mapped multiple times with different comments or dependencies.ConceptMap.group.element(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Identity (code or path) or the element/item being mapped.; (xsd)code>?
< The display for the code. The display is only provided to help editors when editing the concept map. The display is ignored when processing the map.; (xsd)display:string>?
< The set of concepts from the ConceptMap.group.source code system which are all being mapped to the target as part of this mapping rule. If the value set expansion is empty then there are no source concepts to map in this rule.; (xsd)valueSet:ValueSet*>?
< If noMap = true this indicates that no mapping to a target concept exists for this source concept. If noMap = true, then the behavior of ConceptMap.group.unmapped (if present) does not apply.; (xsd)noMap:boolean>?
[]< A concept from the target value set that this concept maps to. Ideally there would only be one map, with an 'equivalent' mapping. But multiple maps are allowed for several narrower (i.e. source-is-broader-than-target) options, or to assert that other concepts are not related.; (xsd)target:ConceptMap.group.element.target>*🔗 A concept from the target value set that this concept maps to. Ideally there would only be one map, with an 'equivalent' mapping. But multiple maps are allowed for several narrower (i.e. source-is-broader-than-target) options, or to assert that other concepts are not related.ConceptMap.group.element.target(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Identity (code or path) or the element/item that the map refers to.; (xsd)code>?
< The display for the code. The display is only provided to help editors when editing the concept map. The display is ignored when processing the map.; (xsd)display:string>?
< The set of concepts from the ConceptMap.group.target code system which are all being mapped to as part of this mapping rule. The effect of using this data element is the same as having multiple ConceptMap.group.element.target elements with one for each concept in the ConceptMap.group.element.target.valueSet value set. If the the value set expansion is empty then the source concept(s) are unmapped and the behavior of ConceptMap.group.unmapped (if present) applies.; (xsd)valueSet:ValueSet*>?
< The relationship between the source and target concepts. The relationship is read from source to target (e.g. source-is-narrower-than-target). This element is labeled as a modifier because it may indicate that there is no mapping. Binding: concept-map-relationship (required, The relationship between concepts.); (xsd)relationship:code>
< A description of status/issues in mapping that conveys additional information not represented in the structured data.; (xsd)comment:string>?
[]< A property value for this source -> target mapping.; (xsd)property:ConceptMap.group.element.target.property>*
[]< A set of additional dependencies for this mapping to hold. This mapping is only applicable if the specified data attribute can be resolved, and it has the specified value.; (xsd)dependsOn:ConceptMap.group.element.target.dependsOn>*
[]< Product is the output of a ConceptMap that provides additional values that go in other attributes / data elemnts of the target data.; (xsd)product:ConceptMap.group.element.target.dependsOn>*🔗 A set of additional dependencies for this mapping to hold. This mapping is only applicable if the specified data attribute can be resolved, and it has the specified value.ConceptMap.group.element.target.dependsOn(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A reference to the additional attribute that holds a value the map depends on.; (xsd)attribute:code>
(<valueBoolean:boolean>
|<valueCode:code>
|<valueCoding:Coding>
|<valueQuantity:Quantity>
|<valueString:string>)?
< This mapping applies if the data element value is a code from this value set.; (xsd)valueSet:ValueSet*>?🔗 A property value for this source -> target mapping.ConceptMap.group.element.target.property(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A reference to a mapping property defined in ConceptMap.property.; (xsd)code>
(<valueBoolean:boolean>
|<valueCode:code>
|<valueCoding:Coding>
|<valueDateTime:dateTime>
|<valueDecimal:decimal>
|<valueInteger:integer>
|<valueString:string>)🔗 What to do when there is no mapping to a target concept from the source concept and ConceptMap.group.element.noMap is not true. This provides the "default" to be applied when there is no target concept mapping specified or the expansion of ConceptMap.group.element.target.valueSet is empty. The 'unmapped' element is ignored if a code is specified to have relationship = not-related-to or if ConceptMap.group.element.noMap = true.ConceptMap.group.unmapped(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Defines which action to take if there is no match for the source concept in the target system designated for the group. One of 3 actions are possible: use the unmapped source code (this is useful when doing a mapping between versions, and only a few codes have changed), use a fixed code (a default code), or alternatively, a reference to a different concept map can be provided (by canonical URL). Binding: conceptmap-unmapped-mode (required, Defines which action to take if there is no match in the group.); (xsd)mode:code>
< The fixed code to use when the mode = 'fixed' - all unmapped codes are mapped to a single fixed code.; (xsd)code>?
< The display for the code. The display is only provided to help editors when editing the concept map. The display is ignored when processing the map.; (xsd)display:string>?
< The set of fixed codes to use when the mode = 'fixed' - all unmapped codes are mapped to each of the fixed codes.; (xsd)valueSet:ValueSet*>?
< The default relationship value to apply between the source and target concepts when the source code is unmapped and the mode is 'fixed' or 'use-source-code'. This element is labeled as a modifier because it may indicate that there is no mapping. Binding: concept-map-relationship (required, The default relationship value to apply between the source and target concepts when no concept mapping is specified.); (xsd)relationship:code>?
< The canonical reference to an additional ConceptMap resource instance to use for mapping if this ConceptMap resource contains no matching mapping for the source concept.; (xsd)otherMap:ConceptMap*>?🔗 A property defines a slot through which additional information can be provided about a map from source -> target. Properties may be used to supply for example, mapping priority, provenance, presentation hints, flag as experimental, and additional documentation. Multiple occurrences of ConceptMap.group.element.target.property may occur for a ConceptMap.property where ConceptMap.group.element.target.property.code is the same and the values in ConceptMap.group.element.target.property.value differ.ConceptMap.property(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A code that is used to identify the property. The code is used internally (in ConceptMap.group.element.target.property.code) and also in the $translate operation.; (xsd)code>
< Reference to the formal meaning of the property.; (xsd)uri>?
< A description of the property - why it is defined, and how its value might be used.; (xsd)description:string>?
< The type of the property value. Binding: conceptmap-property-type (required, The type of a property value.); (xsd)type:code>
< The CodeSystem that defines the codes from which values of type ```code``` in property values.; (xsd)system:CodeSystem*>?🔗 A clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern.Condition(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< Business identifiers assigned to this condition by the performer or other systems which remain constant as the resource is updated and propagates from server to server. This is a business identifier, not a resource identifier (see [discussion](resource.html#identifiers)). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.; (xsd)identifier:Identifier>*
< The clinical status of the condition. The data type is CodeableConcept because clinicalStatus has some clinical judgment involved, such that there might need to be more specificity than the required FHIR value set allows. For example, a SNOMED coding might allow for additional specificity. clinicalStatus is required since it is a modifier element. For conditions that are problems list items, the clinicalStatus should not be unknown. For conditions that are not problem list items, the clinicalStatus may be unknown. For example, conditions derived from a claim are point in time, so those conditions may have a clinicalStatus of unknown Binding: condition-clinical (required, The clinical status of the condition or diagnosis.); (xsd)clinicalStatus:CodeableConcept>
< The verification status to support the clinical status of the condition. The verification status pertains to the condition, itself, not to any specific condition attribute. verificationStatus is not required. For example, when a patient has abdominal pain in the ED, there is not likely going to be a verification status.
The data type is CodeableConcept because verificationStatus has some clinical judgment involved, such that there might need to be more specificity than the required FHIR value set allows. For example, a SNOMED coding might allow for additional specificity. Binding: condition-ver-status (required, The verification status to support or decline the clinical status of the condition or diagnosis.); (xsd)verificationStatus:CodeableConcept>?
[]< A category assigned to the condition. The categorization is often highly contextual and may appear poorly differentiated or not very useful in other contexts. Binding: condition-category (preferred, A category assigned to the condition.); (xsd)category:CodeableConcept>*
< A subjective assessment of the severity of the condition as evaluated by the clinician. Coding of the severity with a terminology is preferred, where possible. Binding: condition-severity (preferred, A subjective assessment of the severity of the condition as evaluated by the clinician.); (xsd)severity:CodeableConcept>?
< Identification of the condition, problem or diagnosis. Binding: condition-code (example, Identification of the condition or diagnosis.); (xsd)code:CodeableConcept>?
[]< The anatomical location where this condition manifests itself. Only used if not implicit in code found in Condition.code. If the use case requires attributes from the BodyStructure resource (e.g. to identify and track separately) then use the standard extension [http://hl7.org/fhir/StructureDefinition/bodySite](http://hl7.org/fhir/extensions/StructureDefinition-bodySite.html). May be a summary code, or a reference to a very precise definition of the location, or both. Binding: body-site (example, SNOMED CT Body site concepts); (xsd)bodySite:CodeableConcept>*
< Indicates the patient or group who the condition record is associated with.; (xsd)subject:(<Group>
|<Patient>)>
< The Encounter during which this Condition was created or to which the creation of this record is tightly associated. This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter. This record indicates the encounter this particular record is associated with. In the case of a "new" diagnosis reflecting ongoing/revised information about the condition, this might be distinct from the first encounter in which the underlying condition was first "known".; (xsd)encounter:Encounter*>?
< Estimated or actual date or date-time the condition began, in the opinion of the clinician. Age is generally used when the patient reports an age at which the Condition began to occur. Period is generally used to convey an imprecise onset that occurred within the time period. For example, Period is not intended to convey the transition period before the chronic bronchitis or COPD condition was diagnosed, but Period can be used to convey an imprecise diagnosis date. Range is generally used to convey an imprecise age range (e.g. 4 to 6 years old). Because a Condition.code can represent multiple levels of granularity and can be modified over time, the onset and abatement dates can have ambiguity whether those dates apply to the current Condition.code or an earlier representation of that Condition.code. For example, if the Condition.code was initially documented as severe asthma, then it is ambiguous whether the onset and abatement dates apply to asthma (overall in that subject's lifetime) or when asthma transitioned to become severe.; (xsd)onset:(<Age>
|<dateTime>
|<Period>
|<Range>
|<string>)>?
< The date or estimated date that the condition resolved or went into remission. This is called "abatement" because of the many overloaded connotations associated with "remission" or "resolution" - Some conditions, such as chronic conditions, are never really resolved, but they can abate. There is no explicit distinction between resolution and remission because in many cases the distinction is not clear. Age is generally used when the patient reports an age at which the Condition abated. If there is no abatement element, it is unknown whether the condition has resolved or entered remission; applications and users should generally assume that the condition is still valid. When abatementString exists, it implies the condition is abated.
Because a Condition.code can represent multiple levels of granularity and can be modified over time, the onset and abatement dates can have ambiguity whether those dates apply to the current Condition.code or an earlier representation of that Condition.code. For example, if the Condition.code was initially documented as severe asthma, then it is ambiguous whether the onset and abatement dates apply to asthma (overall in that subject's lifetime) or when asthma transitioned to become severe.; (xsd)abatement:(<Age>
|<dateTime>
|<Period>
|<Range>
|<string>)>?
< The recordedDate represents when this particular Condition record was created in the system, which is often a system-generated date. When onset date is unknown, recordedDate can be used to establish if the condition was present on or before a given date. If the recordedDate is known and provided by a sending system, it is preferred that the receiving system preserve that recordedDate value. If the recordedDate is not provided by the sending system, the receipt timestamp is sometimes used as the recordedDate.; (xsd)recordedDate:dateTime>?
[]< Indicates who or what participated in the activities related to the condition and how they were involved.; (xsd)participant:Condition.participant>*
[]< A simple summary of the stage such as "Stage 3" or "Early Onset". The determination of the stage is disease-specific, such as cancer, retinopathy of prematurity, kidney diseases, Alzheimer's, or Parkinson disease.; (xsd)stage:Condition.stage>*
[]< Supporting evidence / manifestations that are the basis of the Condition's verification status, such as evidence that confirmed or refuted the condition. If the condition was confirmed, but subsequently refuted, then the evidence can be cumulative including all evidence over time. The evidence may be a simple list of coded symptoms/manifestations, or references to observations or formal assessments, or both. For example, if the Condition.code is pneumonia, then there could be an evidence list where Condition.evidence.concept = fever (CodeableConcept), Condition.evidence.concept = cough (CodeableConcept), and Condition.evidence.reference = bronchitis (reference to Condition). Binding: clinical-findings (example, ); (xsd)evidence:Resource*>*
[]< Additional information about the Condition. This is a general notes/comments entry for description of the Condition, its diagnosis and prognosis.; (xsd)note:Annotation>*🔗 Indicates who or what participated in the activities related to the condition and how they were involved.Condition.participant(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Distinguishes the type of involvement of the actor in the activities related to the condition. Binding: participation-role-type (extensible, ); (xsd)function:CodeableConcept>?
< Indicates who or what participated in the activities related to the condition.; (xsd)actor:(<CareTeam>
|<Device>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>🔗 A simple summary of the stage such as "Stage 3" or "Early Onset". The determination of the stage is disease-specific, such as cancer, retinopathy of prematurity, kidney diseases, Alzheimer's, or Parkinson disease.Condition.stage(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A simple summary of the stage such as "Stage 3" or "Early Onset". The determination of the stage is disease-specific, such as cancer, retinopathy of prematurity, kidney diseases, Alzheimer's, or Parkinson disease. Binding: condition-stage (example, Codes describing condition stages (e.g. Cancer stages).); (xsd)summary:CodeableConcept>?
[]< Reference to a formal record of the evidence on which the staging assessment is based.; (xsd)assessment:(<ClinicalImpression>
|<DiagnosticReport>
|<Observation>)>*
< The kind of staging, such as pathological or clinical staging. Binding: condition-stage-type (example, Codes describing the kind of condition staging (e.g. clinical or pathological).); (xsd)type:CodeableConcept>?🔗 A definition of a condition and information relevant to managing it.ConditionDefinition(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< An absolute URI that is used to identify this condition definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this condition definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the condition definition is stored on different servers. Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.
The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions).
In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.; (xsd)url:uri>?
[]< A formal identifier that is used to identify this condition definition when it is represented in other formats, or referenced in a specification, model, design or an instance. Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this condition definition outside of FHIR, where it is not possible to use the logical URI.; (xsd)identifier:Identifier>*
< The identifier that is used to identify this version of the condition definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the condition definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. There may be different condition definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the condition definition with the format [url]|[version]. The version SHOULD NOT contain a '#' - see [Business Version](resource.html#bv-format).; (xsd)version:string>?
< Indicates the mechanism used to compare versions to determine which is more current. If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined. Binding: version-algorithm (extensible, ); (xsd)versionAlgorithm:(<Coding>
|<string>)>?
< A natural language name identifying the condition definition. This name should be usable as an identifier for the module by machine processing applications such as code generation. The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.; (xsd)name:string>?
< A short, descriptive, user-friendly title for the condition definition. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.; (xsd)title:string>?
< An explanatory or alternate title for the event definition giving additional information about its content.; (xsd)subtitle:string>?
< The status of this condition definition. Enables tracking the life-cycle of the content. Allows filtering of condition definitions that are appropriate for use versus not.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization). Binding: publication-status (required, The lifecycle status of an artifact.); (xsd)status:code>
< A Boolean value to indicate that this condition definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. Allows filtering of condition definitions that are appropriate for use versus not.; (xsd)experimental:boolean>?
< The date (and optionally time) when the condition definition was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the condition definition changes. The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the condition definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)date:dateTime>?
< The name of the organization or individual responsible for the release and ongoing maintenance of the condition definition. Usually an organization but may be an individual. The publisher (or steward) of the condition definition is the organization or individual primarily responsible for the maintenance and upkeep of the condition definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the condition definition. This item SHOULD be populated unless the information is available from context.; (xsd)publisher:string>?
[]< Contact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)contact:ContactDetail>*
< A free text natural language description of the condition definition from a consumer's perspective. This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the condition definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the condition definition is presumed to be the predominant language in the place the condition definition was created).; (xsd)description:markdown>?
[]< The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate condition definition instances. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.; (xsd)useContext:UsageContext>*
[]< A legal or geographic region in which the condition definition is intended to be used. It may be possible for the condition definition to be used in jurisdictions other than those for which it was originally designed or intended.
DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.) Binding: jurisdiction (extensible, Countries and regions within which this artifact is targeted for use.); (xsd)jurisdiction:CodeableConcept>*
< Identification of the condition, problem or diagnosis. Binding: condition-code (example, Identification of the condition or diagnosis.); (xsd)code:CodeableConcept>
< A subjective assessment of the severity of the condition as evaluated by the clinician. Coding of the severity with a terminology is preferred, where possible. Binding: condition-severity (preferred, A subjective assessment of the severity of the condition as evaluated by the clinician.); (xsd)severity:CodeableConcept>?
< The anatomical location where this condition manifests itself. Only used if not implicit in code found in ConditionDefinition.code. If the use case requires attributes from the BodySite resource (e.g. to identify and track separately) then use the standard extension [http://hl7.org/fhir/StructureDefinition/bodySite](http://hl7.org/fhir/extensions/StructureDefinition-bodySite.html). May be a summary code, or a reference to a very precise definition of the location, or both. Binding: body-site (example, SNOMED CT Body site concepts); (xsd)bodySite:CodeableConcept>?
< Clinical stage or grade of a condition. May include formal severity assessments. Binding: condition-stage (example, Codes describing condition stages (e.g. Cancer stages).); (xsd)stage:CodeableConcept>?
< Whether Severity is appropriate to collect for this condition.; (xsd)hasSeverity:boolean>?
< Whether bodySite is appropriate to collect for this condition.; (xsd)hasBodySite:boolean>?
< Whether stage is appropriate to collect for this condition.; (xsd)hasStage:boolean>?
[]< Formal definitions of the condition. These may be references to ontologies, published clinical protocols or research papers.; (xsd)definition:uri>*
[]< Observations particularly relevant to this condition.; (xsd)observation:ConditionDefinition.observation>*
[]< Medications particularly relevant for this condition.; (xsd)medication:ConditionDefinition.medication>*
[]< An observation that suggests that this condition applies.; (xsd)precondition:ConditionDefinition.precondition>*
[]< Appropriate team for this condition.; (xsd)team:CareTeam*>*
[]< Questionnaire for this condition.; (xsd)questionnaire:ConditionDefinition.questionnaire>*
[]< Plan that is appropriate.; (xsd)plan:ConditionDefinition.plan>*🔗 Medications particularly relevant for this condition.ConditionDefinition.medication(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Category that is relevant. Binding: http://terminology.hl7.org/ValueSet/medicationrequest-category (example, A coded concept identifying the category of medication request. For example, where the medication is to be consumed or administered, or the type of medication treatment.); (xsd)category:CodeableConcept>?
< Code for relevant Medication. Binding: medication-codes (example, A coded concept identifying substance or product that can be ordered.); (xsd)code:CodeableConcept>?🔗 Observations particularly relevant to this condition.ConditionDefinition.observation(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Category that is relevant. Binding: observation-category (preferred, Codes for high level observation categories.); (xsd)category:CodeableConcept>?
< Code for relevant Observation. Binding: observation-codes (example, Codes identifying names of simple observations.); (xsd)code:CodeableConcept>?🔗 Plan that is appropriate.ConditionDefinition.plan(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Use for the plan.; (xsd)role:CodeableConcept>?
< The actual plan.; (xsd)reference:PlanDefinition*>🔗 An observation that suggests that this condition applies.ConditionDefinition.precondition(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Kind of pre-condition. Binding: condition-precondition-type (required, Kind of precondition for the condition.); (xsd)type:code>
< Code for relevant Observation. Binding: observation-codes (example, Codes identifying names of simple observations.); (xsd)code:CodeableConcept>
(<valueCodeableConcept:CodeableConcept>
|<valueQuantity:Quantity>)?🔗 Questionnaire for this condition.ConditionDefinition.questionnaire(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Use of the questionnaire. Binding: condition-questionnaire-purpose (required, The use of a questionnaire.); (xsd)purpose:code>
< Specific Questionnaire.; (xsd)reference:Questionnaire*>🔗 A record of a healthcare consumer’s choices or choices made on their behalf by a third party, which permits or denies identified recipient(s) or recipient role(s) to perform one or more actions within a given policy context, for specific purposes and periods of time. Broadly, there are 3 key areas of consent for patients: Consent around sharing information (aka Privacy Consent Directive - Authorization to Collect, Use, or Disclose information), consent for specific treatment, or kinds of treatment and consent for research participation and data sharing.Consent(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< Unique identifier for this copy of the Consent Statement. This identifier identifies this copy of the consent. Where this identifier is also used elsewhere as the identifier for a consent record (e.g. a CDA consent document) then the consent details are expected to be the same.; (xsd)identifier:Identifier>*
< Indicates the current state of this Consent resource. This element is labeled as a modifier because the status contains the codes rejected and entered-in-error that mark the Consent as not currently valid. Binding: consent-state-codes (required, Indicates the state of the consent.); (xsd)status:code>
[]< A classification of the type of consents found in the statement. This element supports indexing and retrieval of consent statements. Binding: consent-category (example, A classification of the type of consents found in a consent statement.); (xsd)category:CodeableConcept>*
< The patient/healthcare practitioner or group of persons to whom this consent applies.; (xsd)subject:(<Group>
|<Patient>
|<Practitioner>)>?
< Date the consent instance was agreed to.; (xsd)date>?
< Effective period for this Consent Resource and all provisions unless specified in that provision.; (xsd)period:Period>?
[]< The entity responsible for granting the rights listed in a Consent Directive.; (xsd)grantor:(<CareTeam>
|<HealthcareService>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>*
[]< The entity responsible for complying with the Consent Directive, including any obligations or limitations on authorizations and enforcement of prohibitions. In a fully computable consent, both grantee and grantor will be listed as actors within the consent. The Grantee and Grantor elements are for ease of search only.; (xsd)grantee:(<CareTeam>
|<HealthcareService>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>*
[]< The actor that manages the consent through its lifecycle.; (xsd)manager:(<HealthcareService>
|<Organization>
|<Patient>
|<Practitioner>)>*
[]< The actor that controls/enforces the access according to the consent.; (xsd)controller:(<HealthcareService>
|<Organization>
|<Patient>
|<Practitioner>)>*
[]< The source on which this consent statement is based. The source might be a scanned original paper form. The source can be contained inline (Attachment), referenced directly (Consent), referenced in a consent repository (DocumentReference), or simply by an identifier (Identifier), e.g. a CDA document id.; (xsd)sourceAttachment:Attachment>*
[]< A reference to a consent that links back to such a source, a reference to a document repository (e.g. XDS) that stores the original consent document. The source can be contained inline (Attachment), referenced directly (Consent), referenced in a consent repository (DocumentReference), or simply by an identifier (Identifier), e.g. a CDA document id.; (xsd)sourceReference:(<Consent>
|<Contract>
|<DocumentReference>
|<QuestionnaireResponse>)>*
[]< A set of codes that indicate the regulatory basis (if any) that this consent supports. Binding: consent-policy (example, Regulatory policy examples); (xsd)regulatoryBasis:CodeableConcept>*
< A Reference or URL used to uniquely identify the policy the organization will enforce for this Consent. This Reference or URL should be specific to the version of the policy and should be dereferencable to a computable policy of some form.; (xsd)policyBasis:Consent.policyBasis>?
[]< A Reference to the human readable policy explaining the basis for the Consent.; (xsd)policyText:DocumentReference*>*
[]< Whether a treatment instruction (e.g. artificial respiration: yes or no) was verified with the patient, his/her family or another authorized person.; (xsd)verification:Consent.verification>*
< Action to take - permit or deny - as default. Binding: consent-provision-type (required, Sets the base decision for Consent to be either permit or deny, with provisions assumed to be a negation of the previous level.); (xsd)decision:code>?
[]< An exception to the base policy of this consent. An exception can be an addition or removal of access permissions.; (xsd)provision:Consent.provision>*🔗 A Reference or URL used to uniquely identify the policy the organization will enforce for this Consent. This Reference or URL should be specific to the version of the policy and should be dereferencable to a computable policy of some form.Consent.policyBasis(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A Reference that identifies the policy the organization will enforce for this Consent. While any resource may be used, Consent, PlanDefinition and Contract would be most frequent; (xsd)reference:Resource*>?
< A URL that links to a computable version of the policy the organization will enforce for this Consent.; (xsd)url>?🔗 An exception to the base policy of this consent. An exception can be an addition or removal of access permissions.Consent.provision(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Timeframe for this provision. This is the bound effective time of the consent and should be in the base provision in the Consent resource.; (xsd)period:Period>?
[]< Who or what is controlled by this provision. Use group to identify a set of actors by some property they share (e.g. 'admitting officers').; (xsd)actor:Consent.provision.actor>*
[]< Actions controlled by this provision. Note that this is the direct action (not the grounds for the action covered in the purpose element). At present, the only action in the understood and tested scope of this resource is 'read'. Binding: consent-action (example, Detailed codes for the consent action.); (xsd)action:CodeableConcept>*
[]< A security label, comprised of 0..* security label fields (Privacy tags), which define which resources are controlled by this exception. If the consent specifies a security label of "R" then it applies to all resources that are labeled "R" or lower. E.g. for Confidentiality, it's a high water mark. For other kinds of security labels, subsumption logic applies. When the purpose of use tag is on the data, access request purpose of use shall not conflict. Binding: security-label-examples (example, Example Security Labels from the Healthcare Privacy and Security Classification System.); (xsd)securityLabel:Coding>*
[]< The context of the activities a user is taking - why the user is accessing the data - that are controlled by this provision. When the purpose of use tag is on the data, access request purpose of use shall not conflict. Binding: http://terminology.hl7.org/ValueSet/v3-PurposeOfUse (extensible, What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels.); (xsd)purpose:Coding>*
[]< The documentType(s) covered by this provision. The type can be a CDA document, or some other type that indicates what sort of information the consent relates to. Multiple types are or'ed together. The intention of the documentType element is that the codes refer to document types defined in a standard somewhere. Binding: consent-content-class (preferred, The document type a consent provision covers.); (xsd)documentType:Coding>*
[]< The resourceType(s) covered by this provision. The type can be a FHIR resource type or a profile on a type that indicates what information the consent relates to. Multiple types are or'ed together. The intention of the resourceType element is that the codes refer to profiles or document types defined in a standard or an implementation guide somewhere. Binding: resource-types (extensible, The resource types a consent provision covers.); (xsd)resourceType:Coding>*
[]< If this code is found in an instance, then the provision applies. Binding: consent-content-code (example, If this code is found in an instance, then the exception applies.); (xsd)code:CodeableConcept>*
< Clinical or Operational Relevant period of time that bounds the data controlled by this provision. This has a different sense to the Consent.period - that is when the consent agreement holds. This is the time period of the data that is controlled by the agreement.; (xsd)dataPeriod:Period>?
[]< The resources controlled by this provision if specific resources are referenced.; (xsd)data:Consent.provision.data>*
< A computable (FHIRPath or other) definition of what is controlled by this consent. Constraining the expression type for a specific implementation via profile is recommended; (xsd)expression:Expression>?
[]< Provisions which provide exceptions to the base provision or subprovisions.; (xsd)provision:Consent.provision>*🔗 Who or what is controlled by this provision. Use group to identify a set of actors by some property they share (e.g. 'admitting officers').Consent.provision.actor(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< How the individual is involved in the resources content that is described in the exception. Binding: participation-role-type (extensible, How an actor is involved in the consent considerations.); (xsd)role:CodeableConcept>?
< The resource that identifies the actor. To identify actors by type, use group to identify a set of actors by some property they share (e.g. 'admitting officers').; (xsd)reference:(<CareTeam>
|<Device>
|<Group>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>?🔗 The resources controlled by this provision if specific resources are referenced.Consent.provision.data(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< How the resource reference is interpreted when testing consent restrictions. Binding: consent-data-meaning (required, How a resource reference is interpreted when testing consent restrictions.); (xsd)meaning:code>
< A reference to a specific resource that defines which resources are covered by this consent.; (xsd)reference:Resource*>🔗 Whether a treatment instruction (e.g. artificial respiration: yes or no) was verified with the patient, his/her family or another authorized person.Consent.verification(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Has the instruction been verified.; (xsd)verified:boolean>
< Extensible list of verification type starting with verification and re-validation. This allows the verification element to hold multiple use cases including RelatedPerson verification of the Grantee decision and periodic re-validation of the consent. Binding: consent-verification (example, Types of Verification/Validation.); (xsd)verificationType:CodeableConcept>?
< The person who conducted the verification/validation of the Grantor decision.; (xsd)verifiedBy:(<Organization>
|<Practitioner>
|<PractitionerRole>)>?
< Who verified the instruction (Patient, Relative or other Authorized Person).; (xsd)verifiedWith:(<Patient>
|<RelatedPerson>)>?
[]< Date(s) verification was collected. Allows for history of verification/validation.; (xsd)verificationDate:dateTime>*🔗 Specifies contact information for a person or organization.ContactDetail(xsd)(doc)=
<#base:DataType>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< The name of an individual to contact. If there is no named individual, the telecom information is for the organization as a whole.; (xsd)name:string>?
[]< The contact details for the individual (if a name was provided) or the organization.; (xsd)telecom:ContactPoint>*🔗 Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.ContactPoint(xsd)(doc)=
<#base:DataType>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< Telecommunications form for contact point - what communications system is required to make use of the contact. Binding: contact-point-system (required, Telecommunications form for contact point.); (xsd)system:code>?
< 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.; (xsd)value:string>?
< 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. Binding: contact-point-use (required, Use of contact point.); (xsd)use:code>?
< Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values. Note that rank does not necessarily follow the order in which the contacts are represented in the instance.
Ranks need not be unique. E.g. it's possible to have multiple contacts with rank=1. If the ranks have different systems or uses, this would be interpreted to mean "X is my most preferred phone number, Y is my most preferred email address" or "X is my preferred home email and Y is my preferred work email". If the system and use for equally-ranked contacts are the same, then the level of preference is equivalent for both repetitions.
Ranks need not be sequential and not all repetitions must have a rank. For example, it's possible to have 4 contacts with ranks of 2, 5 and two with no rank specified. That would be interpreted to mean the first is preferred over the second and no preference stated for the remaining contacts.; (xsd)rank:positiveInt>?
< Time period when the contact point was/is in use.; (xsd)period:Period>?🔗 Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.Contract(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< Unique identifier for this Contract or a derivative that references a Source Contract.; (xsd)identifier:Identifier>*
< Canonical identifier for this contract, represented as a URI (globally unique). Used in a domain that uses a supplied contract repository.; (xsd)url:uri>?
< An edition identifier used for business purposes to label business significant variants. Note - This is a business versionId, not a resource version id (see discussion at [Versioning](resource.html#versions))
Comments - There may be different contract instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the plan definition with the format [url]|[version]. The version SHOULD NOT contain a '#' - see [Business Version](resource.html#bv-format).; (xsd)version:string>?
< The status of the resource instance. This element is labeled as a modifier because the status contains codes that mark the contract as not currently valid or active. Binding: contract-status (required, A code specifying the state of the resource instance.); (xsd)status:code>?
< Legal states of the formation of a legal instrument, which is a formally executed written document that can be formally attributed to its author, records and formally expresses a legally enforceable act, process, or contractual duty, obligation, or right, and therefore evidences that act, process, or agreement. Binding: contract-legalstate (extensible, Detailed codes for the legal state of a contract.); (xsd)legalState:CodeableConcept>?
< The URL pointing to a FHIR-defined Contract Definition that is adhered to in whole or part by this Contract.; (xsd)instantiatesCanonical:Contract*>?
< The URL pointing to an externally maintained definition that is adhered to in whole or in part by this Contract.; (xsd)instantiatesUri:uri>?
< The minimal content derived from the basal information source at a specific stage in its lifecycle. Binding: contract-content-derivative (example, This is an example set of Content Derivative type codes, which represent the minimal content derived from the basal information source.); (xsd)contentDerivative:CodeableConcept>?
< When this Contract was issued.; (xsd)issued:dateTime>?
< Relevant time or time-period when this Contract is applicable.; (xsd)applies:Period>?
< Event resulting in discontinuation or termination of this Contract instance by one or more parties to the contract. Binding: contract-expiration-type (example, Codes for the Cessation of Contracts.); (xsd)expirationType:CodeableConcept>?
[]< The target entity impacted by or of interest to parties to the agreement. The Contract.subject is an entity that has some role with respect to the Contract.topic and Contract.topic.term, which is of focal interest to the parties to the contract and likely impacted in a significant way by the Contract.action/Contract.action.reason and the Contract.term.action/Contract.action.reason.
In many cases, the Contract.subject is a Contract.signer if the subject is an adult; has a legal interest in the contract; and incompetent to participate in the contract agreement.; (xsd)subject:Resource*>*
[]< A formally or informally recognized grouping of people, principals, organizations, or jurisdictions formed for the purpose of achieving some form of collective action such as the promulgation, administration and enforcement of contracts and policies.; (xsd)authority:Organization*>*
[]< Recognized governance framework or system operating with a circumscribed scope in accordance with specified principles, policies, processes or procedures for managing rights, actions, or behaviors of parties or principals relative to resources.; (xsd)domain:Location*>*
[]< Sites in which the contract is complied with, exercised, or in force.; (xsd)site:Location*>*
< A natural language name identifying this Contract definition, derivative, or instance in any legal state. Provides additional information about its content. This name should be usable as an identifier for the module by machine processing applications such as code generation. The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.; (xsd)name:string>?
< A short, descriptive, user-friendly title for this Contract definition, derivative, or instance in any legal state.; (xsd)title:string>?
< A more detailed or qualifying explanatory or alternate user-friendly title for this Contract definition, derivative, or instance in any legal state.; (xsd)subtitle:string>?
[]< Alternative representation of the title for this Contract definition, derivative, or instance in any legal state., e.g., a domain specific contract number related to legislation.; (xsd)alias:string>*
< The individual or organization that authored the Contract definition, derivative, or instance in any legal state.; (xsd)author:(<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>)>?
< A selector of legal concerns for this Contract definition, derivative, or instance in any legal state. Binding: contract-scope (example, Codes for the range of legal concerns.); (xsd)scope:CodeableConcept>?
< Narrows the range of legal concerns to focus on the achievement of specific contractual objectives. Contractual areas of concern are very broad. This element supports narrowing the area of concern to more specific term topics within this Contract. Given the wide range of contract topics, implementers need to be cognizant of the business use case for which they are designing a FHIR Contract, and narrowly specify the topic being represented with respect to the Contract.type and any specializing Contract.subtype. The same topic, e.g., an asset such as a good or service, such as a real property, medical supply, insurance, information, a procedure or employment, or a manner of conduct, such adherence to a privacy, trust, or security policy, may be the topic of multiple types of contracts.
One way to determine the Contract.topic is to answer the question: "What is the overall objective of this legal instrument?". The Contract.topic is described with more detail by the terms of the Contract.; (xsd)topic:(<CodeableConcept>
|<Resource>)>?
< A high-level category for the legal instrument, whether constructed as a Contract definition, derivative, or instance in any legal state. Provides additional information about its content within the context of the Contract's scope to distinguish the kinds of systems that would be interested in the contract. Binding: contract-type (example, List of overall contract codes.); (xsd)type:CodeableConcept>?
[]< Sub-category for the Contract that distinguishes the kinds of systems that would be interested in the Contract within the context of the Contract's scope. Binding: contract-subtype (example, Detailed codes within the above.); (xsd)subType:CodeableConcept>*
< Precusory content developed with a focus and intent of supporting the formation a Contract instance, which may be associated with and transformable into a Contract.; (xsd)contentDefinition:Contract.contentDefinition>?
[]< One or more Contract Provisions, which may be related and conveyed as a group, and may contain nested groups.; (xsd)term:Contract.term>*
[]< Information that may be needed by/relevant to the performer in their execution of this term action.; (xsd)supportingInfo:Resource*>*
[]< Links to Provenance records for past versions of this Contract definition, derivative, or instance, which identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the Contract. The Provenance.entity indicates the target that was changed in the update (see [Provenance.entity](provenance-definitions.html#Provenance.entity)).; (xsd)relevantHistory:Provenance*>*
[]< Parties with legal standing in the Contract, including the principal parties, the grantor(s) and grantee(s), which are any person or organization bound by the contract, and any ancillary parties, which facilitate the execution of the contract such as a notary or witness. Signers who are principal parties to the contract are bound by the Contract.activity related to the Contract.topic, and the Contract.term(s), which either extend or restrict the overall action on the topic by, for example, stipulating specific policies or obligations constraining actions, action reason, or agents with respect to some or all of the topic.
For example, specifying how policies or obligations shall constrain actions and action reasons permitted or denied on all or a subset of the Contract.topic (e.g., all or a portion of property being transferred by the contract), agents (e.g., who can resell, assign interests, or alter the property being transferred by the contract), actions, and action reasons; or with respect to Contract.terms, stipulating, extending, or limiting the Contract.period of applicability or valuation of items under consideration.; (xsd)signer:Contract.signer>*
[]< The "patient friendly language" versionof the Contract in whole or in parts. "Patient friendly language" means the representation of the Contract and Contract Provisions in a manner that is readily accessible and understandable by a layperson in accordance with best practices for communication styles that ensure that those agreeing to or signing the Contract understand the roles, actions, obligations, responsibilities, and implication of the agreement.; (xsd)friendly:Contract.friendly>*
[]< List of Legal expressions or representations of this Contract.; (xsd)legal:Contract.legal>*
[]< List of Computable Policy Rule Language Representations of this Contract.; (xsd)rule:Contract.rule>*
< Legally binding Contract: This is the signed and legally recognized representation of the Contract, which is considered the "source of truth" and which would be the basis for legal action related to enforcement of this Contract.; (xsd)legallyBinding:(<Attachment>
|<Composition>
|<Contract>
|<DocumentReference>
|<QuestionnaireResponse>)>?🔗 Precusory content developed with a focus and intent of supporting the formation a Contract instance, which may be associated with and transformable into a Contract.Contract.contentDefinition(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Precusory content structure and use, i.e., a boilerplate, template, application for a contract such as an insurance policy or benefits under a program, e.g., workers compensation. Binding: contract-definition-type (example, Detailed codes for the definition of contracts.); (xsd)type:CodeableConcept>
< Detailed Precusory content type. Binding: contract-definition-subtype (example, Detailed codes for the additional definition of contracts.); (xsd)subType:CodeableConcept>?
< The individual or organization that published the Contract precursor content.; (xsd)publisher:(<Organization>
|<Practitioner>
|<PractitionerRole>)>?
< The date (and optionally time) when the contract was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the contract changes.; (xsd)publicationDate:dateTime>?
< amended | appended | cancelled | disputed | entered-in-error | executable +. Binding: contract-publicationstatus (required, Status of the publication of contract content.); (xsd)publicationStatus:code>
< A copyright statement relating to Contract precursor content. Copyright statements are generally legal restrictions on the use and publishing of the Contract precursor content.; (xsd)copyright:markdown>?🔗 The "patient friendly language" versionof the Contract in whole or in parts. "Patient friendly language" means the representation of the Contract and Contract Provisions in a manner that is readily accessible and understandable by a layperson in accordance with best practices for communication styles that ensure that those agreeing to or signing the Contract understand the roles, actions, obligations, responsibilities, and implication of the agreement.Contract.friendly(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Human readable rendering of this Contract in a format and representation intended to enhance comprehension and ensure understandability.; (xsd)content:(<Attachment>
|<Composition>
|<DocumentReference>
|<QuestionnaireResponse>)>🔗 List of Legal expressions or representations of this Contract.Contract.legal(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Contract legal text in human renderable form.; (xsd)content:(<Attachment>
|<Composition>
|<DocumentReference>
|<QuestionnaireResponse>)>🔗 List of Computable Policy Rule Language Representations of this Contract.Contract.rule(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Computable Contract conveyed using a policy rule language (e.g. XACML, DKAL, SecPal).; (xsd)content:(<Attachment>
|<DocumentReference>)>🔗 Parties with legal standing in the Contract, including the principal parties, the grantor(s) and grantee(s), which are any person or organization bound by the contract, and any ancillary parties, which facilitate the execution of the contract such as a notary or witness. Signers who are principal parties to the contract are bound by the Contract.activity related to the Contract.topic, and the Contract.term(s), which either extend or restrict the overall action on the topic by, for example, stipulating specific policies or obligations constraining actions, action reason, or agents with respect to some or all of the topic.
For example, specifying how policies or obligations shall constrain actions and action reasons permitted or denied on all or a subset of the Contract.topic (e.g., all or a portion of property being transferred by the contract), agents (e.g., who can resell, assign interests, or alter the property being transferred by the contract), actions, and action reasons; or with respect to Contract.terms, stipulating, extending, or limiting the Contract.period of applicability or valuation of items under consideration.Contract.signer(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Role of this Contract signer, e.g. notary, grantee. Binding: contract-signer-type (preferred, List of parties who may be signing.); (xsd)type:Coding>
< Party which is a signator to this Contract.; (xsd)party:(<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>
[]< Legally binding Contract DSIG signature contents in Base64.; (xsd)signature:Signature>+🔗 One or more Contract Provisions, which may be related and conveyed as a group, and may contain nested groups.Contract.term(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Unique identifier for this particular Contract Provision.; (xsd)identifier:Identifier>?
< When this Contract Provision was issued.; (xsd)issued:dateTime>?
< Relevant time or time-period when this Contract Provision is applicable.; (xsd)applies:Period>?
< The entity that the term applies to.; (xsd)topic:(<CodeableConcept>
|<Resource>)>?
< A legal clause or condition contained within a contract that requires one or both parties to perform a particular requirement by some specified time or prevents one or both parties from performing a particular requirement by some specified time. Binding: contract-term-type (example, Detailed codes for the types of contract provisions.); (xsd)type:CodeableConcept>?
< A specialized legal clause or condition based on overarching contract type. Binding: contract-term-subtype (example, Detailed codes for the subtypes of contract provisions.); (xsd)subType:CodeableConcept>?
< Statement of a provision in a policy or a contract.; (xsd)text:string>?
[]< Security labels that protect the handling of information about the term and its elements, which may be specifically identified. Within a Contract, a security label may apply to the one to many nested group of terms or to a term, whether inside a group or a singleton. The security label on the entire set of term provision elements may be different from the security labels on a contained offer, asset, valuedItem, or data such as sensitive information, and must be the high water mark of all security labels within the term. Rationale is that a labelled term, which may be disaggregated from the Contract, and must persist the label on the term and on contained elements within other contexts. If more than one policy dictates a level of confidentiality of the term, then each applicable policy may be represented by a security label specific to its requirements.
A Security Label is comprised of 1..1 confidentiality code and 0..* other security label codes (aka "privacy tags". A Security Label is metadata assigned (aka "tagged") to Resources and Resource elements, which specify the confidentiality and sensitivity of the Resource or element and their related attributes, the purposes for which tagged items may be collected, access, used or disclosed, any limitation on the type of entities authorized to engage in permitted purposes, and handling instructions that obligate or prohibit certain actions on the tagged items.; (xsd)securityLabel:Contract.term.securityLabel>*
< The matter of concern in the context of this provision of the agrement.; (xsd)offer:Contract.term.offer>
[]< Contract Term Asset List.; (xsd)asset:Contract.term.asset>*
[]< An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place. Several agents may be associated (i.e. has some responsibility for an activity) with an activity and vice-versa.
For example, in cases of actions initiated by one user for other users, or in events that involve more than one user, hardware device, software, or system process. However, only one user may be the initiator/requestor for the event.; (xsd)action:Contract.term.action>*
[]< Nested group of Contract Provisions.; (xsd)group:Contract.term>*🔗 An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place. Several agents may be associated (i.e. has some responsibility for an activity) with an activity and vice-versa.
For example, in cases of actions initiated by one user for other users, or in events that involve more than one user, hardware device, software, or system process. However, only one user may be the initiator/requestor for the event.Contract.term.action(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< True if the term prohibits the action.; (xsd)doNotPerform:boolean>?
< Activity or service obligation to be done or not done, performed or not performed, effectuated or not by this Contract term. Binding: contract-action (example, Detailed codes for the contract action.); (xsd)type:CodeableConcept>
[]< Entity of the action.; (xsd)subject:Contract.term.action.subject>*
< Reason or purpose for the action stipulated by this Contract Provision. Binding: http://terminology.hl7.org/ValueSet/v3-PurposeOfUse (example, Detailed codes for the contract action reason.); (xsd)intent:CodeableConcept>
[]< Id [identifier??] of the clause or question text related to this action in the referenced form or QuestionnaireResponse.; (xsd)linkId:string>*
< Current state of the term action. Binding: contract-actionstatus (example, Codes for the status of a term action.); (xsd)status:CodeableConcept>
< Encounter or Episode with primary association to the specified term activity.; (xsd)context:(<Encounter>
|<EpisodeOfCare>)>?
[]< Id [identifier??] of the clause or question text related to the requester of this action in the referenced form or QuestionnaireResponse.; (xsd)contextLinkId:string>*
< When action happens.; (xsd)occurrence:(<dateTime>
|<Period>
|<Timing>)>?
[]< Who or what initiated the action and has responsibility for its activation.; (xsd)requester:(<Device>
|<Group>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>*
[]< Id [identifier??] of the clause or question text related to the requester of this action in the referenced form or QuestionnaireResponse.; (xsd)requesterLinkId:string>*
[]< The type of individual that is desired or required to perform or not perform the action. Binding: participation-role-type (example, Codes for the types of action performer.); (xsd)performerType:CodeableConcept>*
< The type of role or competency of an individual desired or required to perform or not perform the action. Binding: security-role-type (example, Codes for the role of the action performer.); (xsd)performerRole:CodeableConcept>?
< Indicates who or what is being asked to perform (or not perform) the ction.; (xsd)performer:(<CareTeam>
|<Device>
|<Location>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>
|<Substance>)>?
[]< Id [identifier??] of the clause or question text related to the reason type or reference of this action in the referenced form or QuestionnaireResponse.; (xsd)performerLinkId:string>*
[]< Rationale for the action to be performed or not performed. Describes why the action is permitted or prohibited. Either a coded concept, or another resource whose existence justifies permitting or not permitting this action. Binding: http://terminology.hl7.org/ValueSet/v3-PurposeOfUse (example, Detailed codes for the contract action reason.); (xsd)reason:(<Condition>
|<DiagnosticReport>
|<DocumentReference>
|<Observation>
|<Questionnaire>
|<QuestionnaireResponse>)>*
[]< Id [identifier??] of the clause or question text related to the reason type or reference of this action in the referenced form or QuestionnaireResponse.; (xsd)reasonLinkId:string>*
[]< Comments made about the term action made by the requester, performer, subject or other participants.; (xsd)note:Annotation>*
[]< Security labels that protects the action.; (xsd)securityLabelNumber:unsignedInt>*🔗 Entity of the action.Contract.term.action.subject(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< The entity the action is performed or not performed on or for.; (xsd)reference:(<Device>
|<Group>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>+
< Role type of agent assigned roles in this Contract. Binding: contract-actorrole (example, Detailed codes for the contract actor role.); (xsd)role:CodeableConcept>?🔗 Contract Term Asset List.Contract.term.asset(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Differentiates the kind of the asset . Binding: contract-assetscope (example, Codes for scoping an asset.); (xsd)scope:CodeableConcept>?
[]< Target entity type about which the term may be concerned. Binding: contract-assettype (example, Condes for the type of an asset.); (xsd)type:CodeableConcept>*
[]< Associated entities.; (xsd)typeReference:Resource*>*
[]< May be a subtype or part of an offered asset. Binding: contract-assetsubtype (example, Condes for the sub-type of an asset.); (xsd)subtype:CodeableConcept>*
< Specifies the applicability of the term to an asset resource instance, and instances it refers to or instances that refer to it, and/or are owned by the offeree. Binding: consent-content-class (extensible, The class (type) of information a consent rule covers.); (xsd)relationship:Coding>?
[]< Circumstance of the asset.; (xsd)context:Contract.term.asset.context>*
< Description of the quality and completeness of the asset that may be a factor in its valuation.; (xsd)condition:string>?
[]< Type of Asset availability for use or ownership. Binding: asset-availability (example, Codes for asset availability.); (xsd)periodType:CodeableConcept>*
[]< Asset relevant contractual time period.; (xsd)period:Period>*
[]< Time period of asset use.; (xsd)usePeriod:Period>*
< Clause or question text (Prose Object) concerning the asset in a linked form, such as a QuestionnaireResponse used in the formation of the contract.; (xsd)text:string>?
[]< Id [identifier??] of the clause or question text about the asset in the referenced form or QuestionnaireResponse.; (xsd)linkId:string>*
[]< Response to assets.; (xsd)answer:Contract.term.offer.answer>*
[]< Security labels that protects the asset.; (xsd)securityLabelNumber:unsignedInt>*
[]< Contract Valued Item List.; (xsd)valuedItem:Contract.term.asset.valuedItem>*🔗 Circumstance of the asset.Contract.term.asset.context(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Asset context reference may include the creator, custodian, or owning Person or Organization (e.g., bank, repository), location held, e.g., building, jurisdiction.; (xsd)reference:Resource*>?
[]< Coded representation of the context generally or of the Referenced entity, such as the asset holder type or location. Binding: contract-assetcontext (example, Codes for the context of the asset.); (xsd)code:CodeableConcept>*
< Context description.; (xsd)text:string>?🔗 Contract Valued Item List.Contract.term.asset.valuedItem(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Specific type of Contract Valued Item that may be priced.; (xsd)entity:(<CodeableConcept>
|<Resource>)>?
< Identifies a Contract Valued Item instance.; (xsd)identifier:Identifier>?
< Indicates the time during which this Contract ValuedItem information is effective.; (xsd)effectiveTime:dateTime>?
< Specifies the units by which the Contract Valued Item is measured or counted, and quantifies the countable or measurable Contract Valued Item instances.; (xsd)quantity:SimpleQuantity>?
< A Contract Valued Item unit valuation measure.; (xsd)unitPrice:Money>?
< A real number that represents a multiplier used in determining the overall value of the Contract Valued Item delivered. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.; (xsd)factor:decimal>?
< An amount that expresses the weighting (based on difficulty, cost and/or resource intensiveness) associated with the Contract Valued Item delivered. The concept of Points allows for assignment of point values for a Contract Valued Item, such that a monetary amount can be assigned to each point.; (xsd)points:decimal>?
< Expresses the product of the Contract Valued Item unitQuantity and the unitPriceAmt. For example, the formula: unit Quantity * unit Price (Cost per Point) * factor Number * points = net Amount. Quantity, factor and points are assumed to be 1 if not supplied.; (xsd)net:Money>?
< Terms of valuation.; (xsd)payment:string>?
< When payment is due.; (xsd)paymentDate:dateTime>?
< Who will make payment.; (xsd)responsible:(<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>?
< Who will receive payment.; (xsd)recipient:(<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>?
[]< Id of the clause or question text related to the context of this valuedItem in the referenced form or QuestionnaireResponse.; (xsd)linkId:string>*
[]< A set of security labels that define which terms are controlled by this condition.; (xsd)securityLabelNumber:unsignedInt>*🔗 The matter of concern in the context of this provision of the agrement.Contract.term.offer(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< Unique identifier for this particular Contract Provision.; (xsd)identifier:Identifier>*
[]< Offer Recipient.; (xsd)party:Contract.term.offer.party>*
< The owner of an asset has the residual control rights over the asset: the right to decide all usages of the asset in any way not inconsistent with a prior contract, custom, or law (Hart, 1995, p. 30). The Contract.topic may be an application for or offer of a policy or service (e.g., uri to a consent directive form or a health insurance policy), which becomes the Contract once accepted by both the grantor and grantee.
The Contract Resource may function simply as the computable representation of the executed contract, which may be the attached to the Contract Resource as the “binding” or as the “friendly” electronic form. For example, a Contract Resource may be automatically populated with the values expressed in a related QuestionnaireResponse.
However, the Contract Resource may be considered the legally binding contract if it is the only “executed” form of this contract, and includes the signatures as *The Contract Resource may function as the computable representation of an application or offer in a pre-executed Contract if the grantor has not entered any values. In this case, it is populated with values in a “legal” form of the application or offer or by the values in an associated Questionnaire. If the grantor has filled in the legal form or the associated Questionnaire Response, then these values are used to populate a pre-executed Contract Resource.
If the Contract.topic is considered an application or offer, then the policy is often required to be attached as the “legal” basis for the application to ensure “informed consent” to the contract, and that any discrepancy between the application and the policy are interpreted against the policy. Implementers should check organizational and jurisdictional policies to determine the relationship among multiple representations of a contract pre- and post-execution.; (xsd)topic:Resource*>?
< Type of Contract Provision such as specific requirements, purposes for actions, obligations, prohibitions, e.g. life time maximum benefit. Binding: contract-term-type (example, Detailed codes for the types of contract provisions.); (xsd)type:CodeableConcept>?
< Type of choice made by accepting party with respect to an offer made by an offeror/ grantee. Binding: http://terminology.hl7.org/ValueSet/v3-ActConsentDirective (extensible, The type of decision made by a grantor with respect to an offer made by a grantee.); (xsd)decision:CodeableConcept>?
[]< How the decision about a Contract was conveyed. Binding: contract-decision-mode (example, Codes for conveying a decision.); (xsd)decisionMode:CodeableConcept>*
[]< Response to offer text.; (xsd)answer:Contract.term.offer.answer>*
< Human readable form of this Contract Offer.; (xsd)text:string>?
[]< The id of the clause or question text of the offer in the referenced questionnaire/response.; (xsd)linkId:string>*
[]< Security labels that protects the offer.; (xsd)securityLabelNumber:unsignedInt>*🔗 Response to offer text.Contract.term.offer.answer(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
(<valueAttachment:Attachment>
|<valueBoolean:boolean>
|<valueCoding:Coding>
|<valueDate:date>
|<valueDateTime:dateTime>
|<valueDecimal:decimal>
|<valueInteger:integer>
|<valueQuantity:Quantity>
|<valueResource:Resource>
|<valueString:string>
|<valueTime:time>
|<valueUri:uri>)🔗 Offer Recipient.Contract.term.offer.party(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< Participant in the offer.; (xsd)reference:(<Device>
|<Group>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>+
< How the party participates in the offer. Binding: contract-party-role (example, Codes for offer participant roles.); (xsd)role:CodeableConcept>🔗 Security labels that protect the handling of information about the term and its elements, which may be specifically identified. Within a Contract, a security label may apply to the one to many nested group of terms or to a term, whether inside a group or a singleton. The security label on the entire set of term provision elements may be different from the security labels on a contained offer, asset, valuedItem, or data such as sensitive information, and must be the high water mark of all security labels within the term. Rationale is that a labelled term, which may be disaggregated from the Contract, and must persist the label on the term and on contained elements within other contexts. If more than one policy dictates a level of confidentiality of the term, then each applicable policy may be represented by a security label specific to its requirements.
A Security Label is comprised of 1..1 confidentiality code and 0..* other security label codes (aka "privacy tags". A Security Label is metadata assigned (aka "tagged") to Resources and Resource elements, which specify the confidentiality and sensitivity of the Resource or element and their related attributes, the purposes for which tagged items may be collected, access, used or disclosed, any limitation on the type of entities authorized to engage in permitted purposes, and handling instructions that obligate or prohibit certain actions on the tagged items.Contract.term.securityLabel(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< Number used to link this term or term element to the applicable Security Label.; (xsd)number:unsignedInt>*
< Security label privacy tag that specifies the level of confidentiality protection required for this term and/or term elements. Binding: contract-security-classification (example, Codes for confidentiality protection.); (xsd)classification:Coding>
[]< Security label privacy tag that specifies the applicable privacy and security policies governing this term and/or term elements. Binding: contract-security-category (example, Codes for policy category.); (xsd)category:Coding>*
[]< Security label privacy tag that specifies the manner in which term and/or term elements are to be protected. Binding: contract-security-control (example, Codes for handling instructions.); (xsd)control:Coding>*🔗 A single issue - either an indication, contraindication, interaction or an undesirable effect for a medicinal product, medication, device or procedure.ContraindicationDefinition(xsd)(doc)=
<#base:ClinicalUseDefinition>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< Business identifier for this issue.; (xsd)identifier:Identifier>*
< indication | contraindication | interaction | undesirable-effect | warning. Binding: clinical-use-definition-type (required, Overall defining type of this clinical use definition.) contraindication; (xsd)type:code>
[]< A categorisation of the issue, primarily for dividing warnings into subject heading areas such as "Pregnancy and Lactation", "Overdose", "Effects on Ability to Drive and Use Machines". Binding: clinical-use-definition-category (preferred, A categorisation for a clinical use information item.); (xsd)category:CodeableConcept>*
[]< The medication, product, substance, device, procedure etc. for which this is an indication.; (xsd)subject:(<ActivityDefinition>
|<BiologicallyDerivedProduct>
|<Device>
|<DeviceDefinition>
|<Medication>
|<MedicinalProductDefinition>
|<NutritionProduct>
|<PlanDefinition>
|<Substance>)>*
< Whether this is a current issue or one that has been retired etc. Binding: publication-status (preferred, The lifecycle status of an artifact.); (xsd)status:CodeableConcept>?
< Specifics for when this is a contraindication.; (xsd)contraindication:ContraindicationDefinition.contraindication>
< Specifics for when this is an indication.; (xsd)indication:ContraindicationDefinition.indication>{0,0}
< Specifics for when this is an interaction.; (xsd)interaction:ContraindicationDefinition.interaction>{0,0}
[]< The population group to which this applies.; (xsd)population:Group*>*
[]< Logic used by the clinical use definition.; (xsd)library:Library*>*
< Describe the possible undesirable effects (negative outcomes) from the use of the medicinal product as treatment.; (xsd)undesirableEffect:ContraindicationDefinition.undesirableEffect>{0,0}
< A critical piece of information about environmental, health or physical risks or hazards that serve as caution to the user. For example 'Do not operate heavy machinery', 'May cause drowsiness', or 'Get medical advice/attention if you feel unwell'.; (xsd)warning:ContraindicationDefinition.warning>{0,0}🔗 Specifics for when this is a contraindication.ContraindicationDefinition.contraindication(xsd)(doc)=
<#base:ClinicalUseDefinition.contraindication>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The situation that is being documented as contraindicating against this item. Binding: disease-symptom-procedure (example, A symptom, disease or procedure.); (xsd)diseaseSymptomProcedure:ObservationDefinition*>?
< The status of the disease or symptom for the contraindication, for example "chronic" or "metastatic". Binding: disease-status (example, The status of a disease or symptom.); (xsd)diseaseStatus:ObservationDefinition*>?
[]< A comorbidity (concurrent condition) or coinfection. Binding: disease-symptom-procedure (example, A symptom, disease or procedure.); (xsd)comorbidity:ObservationDefinition*>*
[]< The indication which this is a contraidication for.; (xsd)indication:ClinicalUseDefinition*>*
< An expression that returns true or false, indicating whether the indication is applicable or not, after having applied its other elements. The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.; (xsd)applicability:Expression>?
[]< Information about the use of the medicinal product in relation to other therapies described as part of the contraindication.; (xsd)otherTherapy:ContraindicationDefinition.contraindication.otherTherapy>*🔗 Information about the use of the medicinal product in relation to other therapies described as part of the contraindication.ContraindicationDefinition.contraindication.otherTherapy(xsd)(doc)=
<#base:ClinicalUseDefinition.contraindication.otherTherapy>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The type of relationship between the medicinal product indication or contraindication and another therapy. Binding: therapy-relationship-type (preferred, Classification of relationship between a therapy and a contraindication or an indication.); (xsd)relationshipType:CodeableConcept>
< Reference to a specific medication (active substance, medicinal product or class of products, biological, food etc.) as part of an indication or contraindication. Binding: therapy (example, A therapy.); (xsd)treatment:(<ActivityDefinition>
|<BiologicallyDerivedProduct>
|<Medication>
|<MedicinalProductDefinition>
|<NutritionProduct>
|<Substance>
|<SubstanceDefinition>)>🔗 Specifics for when this is an indication.ContraindicationDefinition.indication(xsd)(doc)=
<#base:ClinicalUseDefinition.indication>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The situation that is being documented as an indicaton for this item. Binding: disease-symptom-procedure (example, A symptom, disease or procedure.); (xsd)diseaseSymptomProcedure:ObservationDefinition*>?
< The status of the disease or symptom for the indication, for example "chronic" or "metastatic". Binding: disease-status (example, The status of a disease or symptom.); (xsd)diseaseStatus:ObservationDefinition*>?
[]< A comorbidity (concurrent condition) or coinfection as part of the indication. Binding: disease-symptom-procedure (example, A symptom, disease or procedure.); (xsd)comorbidity:ObservationDefinition*>*
< The intended effect, aim or strategy to be achieved. Binding: product-intended-use (preferred, The overall intended use of a product.); (xsd)intendedEffect:ObservationDefinition*>?
< Timing or duration information, that may be associated with use with the indicated condition e.g. Adult patients suffering from myocardial infarction (from a few days until less than 35 days), ischaemic stroke (from 7 days until less than 6 months).; (xsd)duration:(<Range>
|<string>)>?
[]< An unwanted side effect or negative outcome that may happen if you use the drug (or other subject of this resource) for this indication.; (xsd)undesirableEffect:ClinicalUseDefinition*>*
< An expression that returns true or false, indicating whether the indication is applicable or not, after having applied its other elements. The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.; (xsd)applicability:Expression>?
[]< Information about the use of the medicinal product in relation to other therapies described as part of the indication.; (xsd)otherTherapy:ClinicalUseDefinition.contraindication.otherTherapy>*🔗 Specifics for when this is an interaction.ContraindicationDefinition.interaction(xsd)(doc)=
<#base:ClinicalUseDefinition.interaction>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< The specific medication, product, food, substance etc. or laboratory test that interacts.; (xsd)interactant:ContraindicationDefinition.interaction.interactant>*
< The type of the interaction e.g. drug-drug interaction, drug-food interaction, drug-lab test interaction. Binding: interaction-type (example, A categorisation for an interaction between two substances.); (xsd)type:CodeableConcept>?
< The effect of the interaction, for example "reduced gastric absorption of primary medication". Binding: interaction-effect (example, A interaction effect of clinical use of a medication or other substance.); (xsd)effect:ObservationDefinition*>?
< The incidence of the interaction, e.g. theoretical, observed. Binding: interaction-incidence (example, A categorisation for incidence of occurence of an interaction.); (xsd)incidence:CodeableConcept>?
[]< Actions for managing the interaction. Binding: interaction-management (example, A type of management for an interaction of a medication or other substance.); (xsd)management:CodeableConcept>*🔗 The specific medication, product, food, substance etc. or laboratory test that interacts.ContraindicationDefinition.interaction.interactant(xsd)(doc)=
<#base:ClinicalUseDefinition.interaction.interactant>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The specific medication, product, food, substance etc. or laboratory test that interacts. Binding: interactant (example, An interactant - a substance that may have a clinically significant effect on another.); (xsd)item:(<BiologicallyDerivedProduct>
|<CodeableConcept>
|<Medication>
|<MedicinalProductDefinition>
|<NutritionProduct>
|<ObservationDefinition>
|<Substance>)>🔗 Describe the possible undesirable effects (negative outcomes) from the use of the medicinal product as treatment.ContraindicationDefinition.undesirableEffect(xsd)(doc)=
<#base:ClinicalUseDefinition.undesirableEffect>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The situation in which the undesirable effect may manifest. Binding: undesirable-effect-symptom (example, An undesirable effect of clinical use.); (xsd)symptomConditionEffect:ObservationDefinition*>?
< High level classification of the effect. Binding: undesirable-effect-classification (example, A categorisation for an undesirable effect.); (xsd)classification:CodeableConcept>?
< How often the effect is seen. Binding: undesirable-effect-frequency (example, A categorisation for a frequency of occurence of an undesirable effect.); (xsd)frequencyOfOccurrence:CodeableConcept>?🔗 A critical piece of information about environmental, health or physical risks or hazards that serve as caution to the user. For example 'Do not operate heavy machinery', 'May cause drowsiness', or 'Get medical advice/attention if you feel unwell'.ContraindicationDefinition.warning(xsd)(doc)=
<#base:ClinicalUseDefinition.warning>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A textual definition of this warning, with formatting.; (xsd)description:markdown>?
< A coded or unformatted textual definition of this warning. Binding: warning-type (example, Classification of warning type.); (xsd)code:CodeableConcept>?🔗 A contributor to the content of a knowledge asset, including authors, editors, reviewers, and endorsers.Contributor(xsd)(doc)=
<#base:DataType>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< The type of contributor. Binding: contributor-type (required, The type of contributor.); (xsd)type:code>
< The name of the individual or organization responsible for the contribution.; (xsd)name:string>
[]< Contact details to assist a user in finding and communicating with the contributor.; (xsd)contact:ContactDetail>*🔗 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(xsd)(doc)=
<#base:Quantity>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< 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).; (xsd)value:decimal>?
< 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. Binding: quantity-comparator (required, How the Quantity should be understood and represented.); (xsd)comparator:code>?
< A human-readable form of the unit.; (xsd)unit:string>?
< The identification of the system that provides the coded form of the unit.; (xsd)system:uri>?
< 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.; (xsd)code>?🔗 Financial instrument which may be used to reimburse or pay for health care products and services. Includes both insurance and self-payment. The Coverage resource contains the insurance card level information, which is customary to provide on claims and other communications between providers and insurers.Coverage(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< The identifier of the coverage as issued by the insurer. The main (and possibly only) identifier for the coverage - often referred to as a Member Id, Certificate number, Personal Health Number or Case ID. May be constructed as the concatenation of the Coverage.SubscriberID and the Coverage.dependant. Note that not all insurers issue unique member IDs therefore searches may result in multiple responses.; (xsd)identifier:Identifier>*
< The status of the resource instance. This element is labeled as a modifier because the status contains the code entered-in-error that marks the coverage as not currently valid. Binding: fm-status (required, A code specifying the state of the resource instance.); (xsd)status:code>
< The nature of the coverage be it insurance, or cash payment such as self-pay. Binding: coverage-kind (required, ); (xsd)kind:code>
[]< Link to the paying party and optionally what specifically they will be responsible to pay.; (xsd)paymentBy:Coverage.paymentBy>*
< The type of coverage: social program, medical plan, accident coverage (workers compensation, auto), group health or payment by an individual or organization. Binding: coverage-type (preferred, The type of insurance: public health, worker compensation; private accident, auto, private health, etc.) or a direct payment by an individual or organization.); (xsd)type:CodeableConcept>?
< The party who 'owns' the insurance policy. For example: may be an individual, corporation or the subscriber's employer.; (xsd)policyHolder:(<Organization>
|<Patient>
|<RelatedPerson>)>?
< The party who has signed-up for or 'owns' the contractual relationship to the policy or to whom the benefit of the policy for services rendered to them or their family is due. May be self or a parent in the case of dependants. A subscriber is only required on certain types of policies not all policies and that it is appropriate to have just a policyholder and a beneficiary when not other party can join that policy instance.; (xsd)subscriber:(<Patient>
|<RelatedPerson>)>?
[]< The insurer assigned ID for the Subscriber.; (xsd)subscriberId:Identifier>*
< The party who benefits from the insurance coverage; the patient when products and/or services are provided.; (xsd)beneficiary:Patient*>
< A designator for a dependent under the coverage. Sometimes the member number is constructed from the subscriberId and the dependant number.; (xsd)dependent:string>?
< The relationship of beneficiary (patient) to the subscriber. Typically, an individual uses policies which are theirs (relationship='self') before policies owned by others. Binding: subscriber-relationship (extensible, The relationship between the Subscriber and the Beneficiary (insured/covered party/patient).); (xsd)relationship:CodeableConcept>?
< Time period during which the coverage is in force. A missing start date indicates the start date isn't known, a missing end date means the coverage is continuing to be in force.; (xsd)period:Period>?
< The program or plan underwriter, payor, insurance company. May provide multiple identifiers such as insurance company identifier or business identifier (BIN number).; (xsd)insurer:Organization*>?
[]< A suite of underwriter specific classifiers. For example, class may be used to identify a class of coverage or employer group, policy, or plan.; (xsd)class:Coverage.class>*
< The order of applicability of this coverage relative to other coverages which are currently in force. Note, there may be gaps in the numbering and this does not imply primary, secondary etc. as the specific positioning of coverages depends upon the episode of care. For example; a patient might have (0) auto insurance (1) their own health insurance and (2) spouse's health insurance. When claiming for treatments which were not the result of an auto accident then only coverages (1) and (2) above would be applicatble and would apply in the order specified in parenthesis.; (xsd)order:positiveInt>?
< The insurer-specific identifier for the insurer-defined network of providers to which the beneficiary may seek treatment which will be covered at the 'in-network' rate, otherwise 'out of network' terms and conditions apply.; (xsd)network:string>?
[]< A suite of codes indicating the cost category and associated amount which have been detailed in the policy and may have been included on the health card. For example by knowing the patient visit co-pay, the provider can collect the amount prior to undertaking treatment.; (xsd)costToBeneficiary:Coverage.costToBeneficiary>*
< When 'subrogation=true' this insurance instance has been included not for adjudication but to provide insurers with the details to recover costs. Typically, automotive and worker's compensation policies would be flagged with 'subrogation=true' to enable healthcare payors to collect against accident claims.; (xsd)subrogation:boolean>?
[]< The policy(s) which constitute this insurance coverage.; (xsd)contract:Contract*>*
< The insurance plan details, benefits and costs, which constitute this insurance coverage.; (xsd)insurancePlan:InsurancePlan*>?🔗 A suite of underwriter specific classifiers. For example, class may be used to identify a class of coverage or employer group, policy, or plan.Coverage.class(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The type of classification for which an insurer-specific class label or number and optional name is provided. For example, type may be used to identify a class of coverage or employer group, policy, or plan. Binding: coverage-class (extensible, The policy classifications, e.g. Group, Plan, Class, etc.); (xsd)type:CodeableConcept>
< The alphanumeric identifier associated with the insurer issued label. For example, the Group or Plan number.; (xsd)value:Identifier>
< A short description for the class.; (xsd)name:string>?🔗 A suite of codes indicating the cost category and associated amount which have been detailed in the policy and may have been included on the health card. For example by knowing the patient visit co-pay, the provider can collect the amount prior to undertaking treatment.Coverage.costToBeneficiary(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The category of patient centric costs associated with treatment. For example visit, specialist visits, emergency, inpatient care, etc. Binding: coverage-copay-type (extensible, The types of services to which patient copayments are specified.); (xsd)type:CodeableConcept>?
< Code to identify the general type of benefits under which products and services are provided. Examples include Medical Care, Periodontics, Renal Dialysis, Vision Coverage. Binding: ex-benefitcategory (example, ); (xsd)category:CodeableConcept>?
< Is a flag to indicate whether the benefits refer to in-network providers or out-of-network providers. Binding: benefit-network (example, ); (xsd)network:CodeableConcept>?
< Indicates if the benefits apply to an individual or to the family. Binding: benefit-unit (example, ); (xsd)unit:CodeableConcept>?
< The term or period of the values such as 'maximum lifetime benefit' or 'maximum annual visits'. Binding: benefit-term (example, ); (xsd)term:CodeableConcept>?
(<valueMoney:Money>
|<valueSimpleQuantity:SimpleQuantity>)?
[]< A suite of codes indicating exceptions or reductions to patient costs and their effective periods.; (xsd)exception:Coverage.costToBeneficiary.exception>*🔗 A suite of codes indicating exceptions or reductions to patient costs and their effective periods.Coverage.costToBeneficiary.exception(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The code for the specific exception. Binding: coverage-financial-exception (example, The types of exceptions from the part or full value of financial obligations such as copays.); (xsd)type:CodeableConcept>
< The timeframe the exception is in force.; (xsd)period:Period>?🔗 Link to the paying party and optionally what specifically they will be responsible to pay.Coverage.paymentBy(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The list of parties providing non-insurance payment for the treatment costs.; (xsd)party:(<Organization>
|<Patient>
|<RelatedPerson>)>
< Description of the financial responsibility.; (xsd)responsibility:string>?🔗 The CoverageEligibilityRequest provides patient and insurance coverage information to an insurer for them to respond, in the form of an CoverageEligibilityResponse, with information regarding whether the stated coverage is valid and in-force and optionally to provide the insurance details of the policy.CoverageEligibilityRequest(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< A unique identifier assigned to this coverage eligiblity request.; (xsd)identifier:Identifier>*
< The status of the resource instance. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. Binding: fm-status (required, A code specifying the state of the resource instance.); (xsd)status:code>
< When the requestor expects the processor to complete processing. Binding: process-priority (example, The timeliness with which processing is required: STAT, normal, Deferred.); (xsd)priority:CodeableConcept>?
[]< Code to specify whether requesting: prior authorization requirements for some service categories or billing codes; benefits for coverages specified or discovered; discovery and return of coverages for the patient; and/or validation that the specified coverage is in-force at the date/period specified or 'now' if not specified. Binding: eligibilityrequest-purpose (required, A code specifying the types of information being requested.); (xsd)purpose:code>+
< The party who is the beneficiary of the supplied coverage and for whom eligibility is sought. 1..1.; (xsd)patient:Patient*>
[]< Information code for an event with a corresponding date or period.; (xsd)event:CoverageEligibilityRequest.event>*
< The date or dates when the enclosed suite of services were performed or completed.; (xsd)serviced:(<date>
|<Period>)>?
< The date when this resource was created.; (xsd)created:dateTime>
< Person who created the request.; (xsd)enterer:(<Practitioner>
|<PractitionerRole>)>?
< The provider which is responsible for the request. Typically this field would be 1..1 where this party is accountable for the data content within the claim but is not necessarily the facility, provider group or practitioner who provided the products and services listed within this claim resource. This field is the Billing Provider, for example, a facility, provider group, lab or practitioner.; (xsd)provider:(<Organization>
|<Practitioner>
|<PractitionerRole>)>?
< The Insurer who issued the coverage in question and is the recipient of the request.; (xsd)insurer:Organization*>
< Facility where the services are intended to be provided.; (xsd)facility:Location*>?
[]< Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues. Often there are multiple jurisdiction specific valuesets which are required.; (xsd)supportingInfo:CoverageEligibilityRequest.supportingInfo>*
[]< Financial instruments for reimbursement for the health care products and services. All insurance coverages for the patient which may be applicable for reimbursement, of the products and services listed in the claim, are typically provided in the claim to allow insurers to confirm the ordering of the insurance coverages relative to local 'coordination of benefit' rules. One coverage (and only one) with 'focal=true' is to be used in the adjudication of this claim. Coverages appearing before the focal Coverage in the list, and where 'subrogation=false', should provide a reference to the ClaimResponse containing the adjudication results of the prior claim.; (xsd)insurance:CoverageEligibilityRequest.insurance>*
[]< Service categories or billable services for which benefit details and/or an authorization prior to service delivery may be required by the payor.; (xsd)item:CoverageEligibilityRequest.item>*🔗 Information code for an event with a corresponding date or period.CoverageEligibilityRequest.event(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A coded event such as when a service is expected or a card printed. Binding: datestype (example, ); (xsd)type:CodeableConcept>
< A date or period in the past or future indicating when the event occurred or is expectd to occur.; (xsd)when:(<dateTime>
|<Period>)>🔗 Financial instruments for reimbursement for the health care products and services. All insurance coverages for the patient which may be applicable for reimbursement, of the products and services listed in the claim, are typically provided in the claim to allow insurers to confirm the ordering of the insurance coverages relative to local 'coordination of benefit' rules. One coverage (and only one) with 'focal=true' is to be used in the adjudication of this claim. Coverages appearing before the focal Coverage in the list, and where 'subrogation=false', should provide a reference to the ClaimResponse containing the adjudication results of the prior claim.CoverageEligibilityRequest.insurance(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A flag to indicate that this Coverage is to be used for evaluation of this request when set to true. A patient may (will) have multiple insurance policies which provide reimburement for healthcare services and products. For example a person may also be covered by their spouse's policy and both appear in the list (and may be from the same insurer). This flag will be set to true for only one of the listed policies and that policy will be used for evaluating this request. Other requests would be created to request evaluation against the other listed policies.; (xsd)focal:boolean>?
< Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system.; (xsd)coverage:Coverage*>
< A business agreement number established between the provider and the insurer for special business processing purposes.; (xsd)businessArrangement:string>?🔗 Service categories or billable services for which benefit details and/or an authorization prior to service delivery may be required by the payor.CoverageEligibilityRequest.item(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< Exceptions, special conditions and supporting information applicable for this service or product line.; (xsd)supportingInfoSequence:positiveInt>*
< Code to identify the general type of benefits under which products and services are provided. Examples include Medical Care, Periodontics, Renal Dialysis, Vision Coverage. Binding: ex-benefitcategory (example, Benefit categories such as: oral, medical, vision etc.); (xsd)category:CodeableConcept>?
< This contains the product, service, drug or other billing code for the item. Code to indicate the Professional Service or Product supplied (e.g. CTP, HCPCS, USCLS, ICD10, NCPDP, DIN, RxNorm, ACHI, CCI). Binding: service-uscls (example, Allowable service and product codes.); (xsd)productOrService:CodeableConcept>?
[]< Item typification or modifiers codes to convey additional context for the product or service. For example in Oral whether the treatment is cosmetic or associated with TMJ, or for Medical whether the treatment was outside the clinic or out of office hours. Binding: claim-modifiers (example, Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.); (xsd)modifier:CodeableConcept>*
< The practitioner who is responsible for the product or service to be rendered to the patient.; (xsd)provider:(<Practitioner>
|<PractitionerRole>)>?
< The number of repetitions of a service or product.; (xsd)quantity:SimpleQuantity>?
< The amount charged to the patient by the provider for a single unit.; (xsd)unitPrice:Money>?
< Facility where the services will be provided.; (xsd)facility:(<Location>
|<Organization>)>?
[]< Patient diagnosis for which care is sought.; (xsd)diagnosis:CoverageEligibilityRequest.item.diagnosis>*
[]< The plan/proposal/order describing the proposed service in detail.; (xsd)detail:Resource*>*🔗 Patient diagnosis for which care is sought.CoverageEligibilityRequest.item.diagnosis(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The nature of illness or problem in a coded form or as a reference to an external defined Condition. Binding: icd-10 (example, ICD10 Diagnostic codes.); (xsd)diagnosis:(<CodeableConcept>
|<Condition>)>?🔗 Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues. Often there are multiple jurisdiction specific valuesets which are required.CoverageEligibilityRequest.supportingInfo(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A number to uniquely identify supporting information entries.; (xsd)sequence:positiveInt>
< Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data. Could be used to provide references to other resources, document. For example could contain a PDF in an Attachment of the Police Report for an Accident.; (xsd)information:Resource*>
< The supporting materials are applicable for all detail items, product/servce categories and specific billing codes.; (xsd)appliesToAll:boolean>?🔗 This resource provides eligibility and plan details from the processing of an CoverageEligibilityRequest resource.CoverageEligibilityResponse(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< A unique identifier assigned to this coverage eligiblity request.; (xsd)identifier:Identifier>*
< The status of the resource instance. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. Binding: fm-status (required, A code specifying the state of the resource instance.); (xsd)status:code>
[]< Code to specify whether requesting: prior authorization requirements for some service categories or billing codes; benefits for coverages specified or discovered; discovery and return of coverages for the patient; and/or validation that the specified coverage is in-force at the date/period specified or 'now' if not specified. Binding: eligibilityresponse-purpose (required, A code specifying the types of information being requested.); (xsd)purpose:code>+
< The party who is the beneficiary of the supplied coverage and for whom eligibility is sought.; (xsd)patient:Patient*>
[]< Information code for an event with a corresponding date or period.; (xsd)event:CoverageEligibilityResponse.event>*
< The date or dates when the enclosed suite of services were performed or completed.; (xsd)serviced:(<date>
|<Period>)>?
< The date this resource was created.; (xsd)created:dateTime>
< The provider which is responsible for the request. This party is responsible for the claim but not necessarily professionally responsible for the provision of the individual products and services listed below. This field is the Billing Provider, for example, a facility, provider group, lab or practitioner.; (xsd)requestor:(<Organization>
|<Practitioner>
|<PractitionerRole>)>?
< Reference to the original request resource.; (xsd)request:CoverageEligibilityRequest*>
< The outcome of the request processing. The resource may be used to indicate that: the request has been held (queued) for processing; that it has been processed and errors found (error); that no errors were found and that some of the adjudication has been undertaken (partial) or that all of the adjudication has been undertaken (complete). Binding: eligibility-outcome (required, The outcome of the processing.); (xsd)outcome:code>
< A human readable description of the status of the adjudication.; (xsd)disposition:string>?
< The Insurer who issued the coverage in question and is the author of the response.; (xsd)insurer:Organization*>
[]< Financial instruments for reimbursement for the health care products and services. All insurance coverages for the patient which may be applicable for reimbursement, of the products and services listed in the claim, are typically provided in the claim to allow insurers to confirm the ordering of the insurance coverages relative to local 'coordination of benefit' rules. One coverage (and only one) with 'focal=true' is to be used in the adjudication of this claim. Coverages appearing before the focal Coverage in the list, and where 'subrogation=false', should provide a reference to the ClaimResponse containing the adjudication results of the prior claim.; (xsd)insurance:CoverageEligibilityResponse.insurance>*
< A reference from the Insurer to which these services pertain to be used on further communication and as proof that the request occurred.; (xsd)preAuthRef:string>?
< A code for the form to be used for printing the content. May be needed to identify specific jurisdictional forms. Binding: forms (example, The forms codes.); (xsd)form:CodeableConcept>?
[]< Errors encountered during the processing of the request.; (xsd)error:CoverageEligibilityResponse.error>*🔗 Errors encountered during the processing of the request.CoverageEligibilityResponse.error(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< An error code,from a specified code system, which details why the eligibility check could not be performed. Binding: adjudication-error (example, The error codes for adjudication processing.); (xsd)code:CodeableConcept>
[]< A [simple subset of FHIRPath](fhirpath.html#simple) limited to element names, repetition indicators and the default child accessor that identifies one of the elements in the resource that caused this issue to be raised. The root of the FHIRPath is the resource or bundle that generated OperationOutcome. Each FHIRPath SHALL resolve to a single node.; (xsd)expression:string>*🔗 Information code for an event with a corresponding date or period.CoverageEligibilityResponse.event(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A coded event such as when a service is expected or a card printed. Binding: datestype (example, ); (xsd)type:CodeableConcept>
< A date or period in the past or future indicating when the event occurred or is expectd to occur.; (xsd)when:(<dateTime>
|<Period>)>🔗 Financial instruments for reimbursement for the health care products and services. All insurance coverages for the patient which may be applicable for reimbursement, of the products and services listed in the claim, are typically provided in the claim to allow insurers to confirm the ordering of the insurance coverages relative to local 'coordination of benefit' rules. One coverage (and only one) with 'focal=true' is to be used in the adjudication of this claim. Coverages appearing before the focal Coverage in the list, and where 'subrogation=false', should provide a reference to the ClaimResponse containing the adjudication results of the prior claim.CoverageEligibilityResponse.insurance(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system.; (xsd)coverage:Coverage*>
< Flag indicating if the coverage provided is inforce currently if no service date(s) specified or for the whole duration of the service dates.; (xsd)inforce:boolean>?
< The term of the benefits documented in this response.; (xsd)benefitPeriod:Period>?
[]< Benefits and optionally current balances, and authorization details by category or service.; (xsd)item:CoverageEligibilityResponse.insurance.item>*🔗 Benefits and optionally current balances, and authorization details by category or service.CoverageEligibilityResponse.insurance.item(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Code to identify the general type of benefits under which products and services are provided. Examples include Medical Care, Periodontics, Renal Dialysis, Vision Coverage. Binding: ex-benefitcategory (example, Benefit categories such as: oral, medical, vision etc.); (xsd)category:CodeableConcept>?
< This contains the product, service, drug or other billing code for the item. Code to indicate the Professional Service or Product supplied (e.g. CTP, HCPCS, USCLS, ICD10, NCPDP, DIN, RxNorm, ACHI, CCI). Binding: service-uscls (example, Allowable service and product codes.); (xsd)productOrService:CodeableConcept>?
[]< Item typification or modifiers codes to convey additional context for the product or service. For example in Oral whether the treatment is cosmetic or associated with TMJ, or for Medical whether the treatment was outside the clinic or out of office hours. Binding: claim-modifiers (example, Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.); (xsd)modifier:CodeableConcept>*
< The practitioner who is eligible for the provision of the product or service.; (xsd)provider:(<Practitioner>
|<PractitionerRole>)>?
< True if the indicated class of service is excluded from the plan, missing or False indicates the product or service is included in the coverage.; (xsd)excluded:boolean>?
< A short name or tag for the benefit. For example: MED01, or DENT2.; (xsd)name:string>?
< A richer description of the benefit or services covered. For example 'DENT2 covers 100% of basic, 50% of major but excludes Ortho, Implants and Cosmetic services'.; (xsd)description:string>?
< Is a flag to indicate whether the benefits refer to in-network providers or out-of-network providers. Binding: benefit-network (example, Code to classify in or out of network services.); (xsd)network:CodeableConcept>?
< Indicates if the benefits apply to an individual or to the family. Binding: benefit-unit (example, Unit covered/serviced - individual or family.); (xsd)unit:CodeableConcept>?
< The term or period of the values such as 'maximum lifetime benefit' or 'maximum annual visits'. Binding: benefit-term (example, Coverage unit - annual, lifetime.); (xsd)term:CodeableConcept>?
[]< Benefits used to date.; (xsd)benefit:CoverageEligibilityResponse.insurance.item.benefit>*
< A boolean flag indicating whether a preauthorization is required prior to actual service delivery.; (xsd)authorizationRequired:boolean>?
[]< Codes or comments regarding information or actions associated with the preauthorization. Binding: coverageeligibilityresponse-ex-auth-support (example, Type of supporting information to provide with a preauthorization.); (xsd)authorizationSupporting:CodeableConcept>*
< A web location for obtaining requirements or descriptive information regarding the preauthorization.; (xsd)authorizationUrl:uri>?🔗 Benefits used to date.CoverageEligibilityResponse.insurance.item.benefit(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Classification of benefit being provided. For example: deductible, visits, benefit amount. Binding: benefit-type (example, Deductable, visits, co-pay, etc.); (xsd)type:CodeableConcept>
< The quantity of the benefit which is permitted under the coverage.; (xsd)allowed:(<Money>
|<string>
|<unsignedInt>)>?
< The quantity of the benefit which have been consumed to date.; (xsd)used:(<Money>
|<string>
|<unsignedInt>)>?🔗 The Library resource is a general-purpose container for knowledge asset definitions. It can be used to describe and expose existing knowledge assets such as logic libraries and information model descriptions, as well as to describe a collection of knowledge assets.cqllibrary(xsd)(doc)=
<#base:logiclibrary>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< An Extension; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< An absolute URI that is used to identify this library when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this library is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the library is stored on different servers. Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.
The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions).
In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.; (xsd)url:uri>
[]< A formal identifier that is used to identify this library when it is represented in other formats, or referenced in a specification, model, design or an instance. e.g. CMS or NQF identifiers for a measure artifact. Note that at least one identifier is required for non-experimental active artifacts. Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this library outside of FHIR, where it is not possible to use the logical URI.; (xsd)identifier:Identifier>*
< The identifier that is used to identify this version of the library when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the library author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts. There may be different library instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the library with the format [url]|[version]. The version SHOULD NOT contain a '#' - see [Business Version](resource.html#bv-format).; (xsd)version:string>
< Indicates the mechanism used to compare versions to determine which is more current. If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined. Binding: version-algorithm (extensible, ); (xsd)versionAlgorithm:(<Coding>
|<string>)>?
< A natural language name identifying the library. This name should be usable as an identifier for the module by machine processing applications such as code generation. The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.; (xsd)name:string>?
< A short, descriptive, user-friendly title for the library. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.; (xsd)title:string>
< An explanatory or alternate title for the library giving additional information about its content.; (xsd)subtitle:string>?
< The status of this library. Enables tracking the life-cycle of the content. Allows filtering of libraries that are appropriate for use vs. not.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization). Binding: publication-status (required, The lifecycle status of an artifact.); (xsd)status:code>
< A Boolean value to indicate that this library is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. Allows filtering of librarys that are appropriate for use versus not.; (xsd)experimental:boolean>?
< Identifies the type of library such as a Logic Library, Model Definition, Asset Collection, or Module Definition. Binding: library-type (extensible, The type of knowledge asset this library contains.); (xsd)type:CodeableConcept>
< A code or group definition that describes the intended subject of the contents of the library. Binding: participant-resource-types (extensible, The possible types of subjects for a library (E.g. Patient, Practitioner, Organization, Location, etc.).); (xsd)subject:(<CodeableConcept>
|<Group>)>?
< The date (and optionally time) when the library was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the library changes. The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the library. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)date:dateTime>?
< The name of the organization or individual responsible for the release and ongoing maintenance of the library. Usually an organization but may be an individual. The publisher (or steward) of the library is the organization or individual primarily responsible for the maintenance and upkeep of the library. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the library. This item SHOULD be populated unless the information is available from context.; (xsd)publisher:string>?
[]< Contact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)contact:ContactDetail>*
< A free text natural language description of the library from a consumer's perspective. This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the library as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the library is presumed to be the predominant language in the place the library was created).; (xsd)description:markdown>
[]< The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate library instances. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.; (xsd)useContext:UsageContext>*
[]< A legal or geographic region in which the library is intended to be used. It may be possible for the library to be used in jurisdictions other than those for which it was originally designed or intended.
DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.) Binding: jurisdiction (extensible, Countries and regions within which this artifact is targeted for use.); (xsd)jurisdiction:CodeableConcept>*
< Explanation of why this library is needed and why it has been designed as it has. This element does not describe the usage of the library. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this library.; (xsd)purpose:markdown>?
< A detailed description of how the library is used from a clinical perspective.; (xsd)usage:markdown>?
< A copyright statement relating to the library and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the library. The short copyright declaration (e.g. (c) '2015+ xyz organization' should be sent in the copyrightLabel element.; (xsd)copyright:markdown>?
< A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved'). The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.; (xsd)copyrightLabel:string>?
< The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)approvalDate:date>?
< The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. If specified, this date follows the original approval date.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)lastReviewDate:date>?
< The period during which the library content was or is planned to be in active use. The effective period for a library determines when the content is applicable for usage and is independent of publication and review dates. For example, a library intended to be used for the year 2016 might be published in 2015.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)effectivePeriod:Period>?
[]< Descriptive topics related to the content of the library. Topics provide a high-level categorization of the library that can be useful for filtering and searching. DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'topic' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#topic and useContext.valueCodeableConcept indicating the topic) Binding: definition-topic (example, High-level categorization of the definition, used for searching, sorting, and filtering.); (xsd)topic:CodeableConcept>*
[]< An individiual or organization primarily involved in the creation and maintenance of the content.; (xsd)author:ContactDetail>*
[]< An individual or organization primarily responsible for internal coherence of the content.; (xsd)editor:ContactDetail>*
[]< An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the content. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)reviewer:ContactDetail>*
[]< An individual or organization asserted by the publisher to be responsible for officially endorsing the content for use in some setting. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)endorser:ContactDetail>*
[]< Related artifacts such as additional documentation, justification, or bibliographic references. Each related artifact is either an attachment, or a reference to another resource, but not both.; (xsd)relatedArtifact:RelatedArtifact>*
[]< The parameter element defines parameters used by the library.; (xsd)parameter:ParameterDefinition>*
[]< Describes a set of data that must be provided in order to be able to successfully perform the computations defined by the library.; (xsd)dataRequirement:DataRequirement>*
[]< The content of the library as an Attachment. The content may be a reference to a url, or may be directly embedded as a base-64 string. Either way, the contentType of the attachment determines how to interpret the content.; (xsd)content:cqllibrary.content>*
[]< Defines a knowledge capability afforded by this knowledge artifact.; (xsd)knowledgeCapability:Extension>*
[]< Defines a knowledge representation level provided by this knowledge artifact.; (xsd)knowledgeRepresentationLevel:Extension>*
[]< A comment containing additional documentation, a review comment, usage guidance, or other relevant information from a particular user.; (xsd)artifactComment:Extension>*
[]< Defines a code directly referenced by artifact logic, as opposed to a value set. Direct reference codes may be the target of data requirements.; (xsd)directReferenceCode:Extension>*
[]< Related artifacts such as additional documentation, justification, or bibliographic references. Each related artifact is either an attachment, or a reference to another resource, but not both.; (xsd)dependency:cqllibrary.dependency>*
< The CQL content represented as base-64 encoded data.; (xsd)cqlContent:cqllibrary.cqlContent>🔗 The content of the library as an Attachment. The content may be a reference to a url, or may be directly embedded as a base-64 string. Either way, the contentType of the attachment determines how to interpret the content.cqllibrary.content(xsd)(doc)=
<#base:logiclibrary.content>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< 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. Binding: mimetypes (required, BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)); (xsd)contentType:code>?
< The human language of the content. The value can be any valid value according to BCP 47. Binding: all-languages (required, IETF language tag for a human language.); (xsd)language:code>?
< 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.; (xsd)data:base64Binary>?
< 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.; (xsd)url>?
< 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.; (xsd)size:integer64>?
< 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.; (xsd)hash:base64Binary>?
< A label or set of text to display in place of the data. May sometimes be derived from the source filename.; (xsd)title:string>?
< The date that the attachment was first created.; (xsd)creation:dateTime>?
< Height of the image in pixels (photo/video).; (xsd)height:positiveInt>?
< Width of the image in pixels (photo/video).; (xsd)width:positiveInt>?
< The number of frames in a photo. This is used with a multi-page fax, or an imaging acquisition context that takes multiple slices in a single image, or an animated gif. If there is more than one frame, this SHALL have a value in order to alert interface software that a multi-frame capable rendering widget is required. if the number of frames is not supplied, the value may be unknown. Applications should not assume that there is only one frame unless it is explicitly stated.; (xsd)frames:positiveInt>?
< The duration of the recording in seconds - for audio and video. The duration might differ from occurrencePeriod if recording was paused.; (xsd)duration:decimal>?
< The number of pages when printed.; (xsd)pages:positiveInt>?🔗 The CQL content represented as base-64 encoded data.cqllibrary.cqlContent(xsd)(doc)=
<#base:Attachment>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< 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. Binding: mimetypes (required, BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)) text/cql; (xsd)contentType:code>
< The human language of the content. The value can be any valid value according to BCP 47. Binding: all-languages (required, IETF language tag for a human language.); (xsd)language:code>?
< 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.; (xsd)data:base64Binary>
< 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.; (xsd)url>?
< 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.; (xsd)size:integer64>?
< 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.; (xsd)hash:base64Binary>?
< A label or set of text to display in place of the data. May sometimes be derived from the source filename.; (xsd)title:string>?
< The date that the attachment was first created.; (xsd)creation:dateTime>?
< Height of the image in pixels (photo/video).; (xsd)height:positiveInt>?
< Width of the image in pixels (photo/video).; (xsd)width:positiveInt>?
< The number of frames in a photo. This is used with a multi-page fax, or an imaging acquisition context that takes multiple slices in a single image, or an animated gif. If there is more than one frame, this SHALL have a value in order to alert interface software that a multi-frame capable rendering widget is required. if the number of frames is not supplied, the value may be unknown. Applications should not assume that there is only one frame unless it is explicitly stated.; (xsd)frames:positiveInt>?
< The duration of the recording in seconds - for audio and video. The duration might differ from occurrencePeriod if recording was paused.; (xsd)duration:decimal>?
< The number of pages when printed.; (xsd)pages:positiveInt>?🔗 Related artifacts such as additional documentation, justification, or bibliographic references. Each related artifact is either an attachment, or a reference to another resource, but not both.cqllibrary.dependency(xsd)(doc)=
<#base:logiclibrary.dependency>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< The type of relationship to the related artifact. The presence of both sides of a relationship type (e.g. successor and predecessor) is required to support use cases where one side of a relationship is not represented in FHIR. However, this feature SHALL NOT be used to create bi-directional resource links in FHIR instances. Specifically, following the methodology of "new points to old" and "many points to one", when using related artifact elements to describe and reference FHIR resources, the type element SHALL be drawn from the fhir-related-artifact-type ValueSet. Binding: related-artifact-type (required, The type of relationship to the related artifact.) depends-on; (xsd)type:code>
[]< Provides additional classifiers of the related artifact. Binding: citation-artifact-classifier (example, Additional classifiers for the related artifact.); (xsd)classifier:CodeableConcept>*
< A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index.; (xsd)label:string>?
< A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.; (xsd)display:string>?
< 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.; (xsd)citation:markdown>?
< The document being referenced, represented as an attachment. This is exclusive with the resource element.; (xsd)document:Attachment>?
< The related artifact, 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.; (xsd)resource:(<CodeSystem>
|<Library>
|<ValueSet>)>
< The related artifact, if the artifact is not a canonical resource, or a resource reference to a canonical resource. If both resource and resourceReference are present, they SHOULD be consistent and reference the same resource. Although relatedArtifact is intended to support references to definitional resources, there are cases where non-definitional resources can be definitional (such as Location where the kind is mode). Related artifacts SHOULD be used to reference definitional resources, and profiles SHOULD be used to make that explicit for particular use cases.; (xsd)resourceReference:Resource*>?
< The publication status of the artifact being referred to. Binding: publication-status (required, Publication status of an artifact being referred to.); (xsd)publicationStatus:code>?
< The date of publication of the artifact being referred to.; (xsd)publicationDate:date>?🔗 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(xsd)(doc)=
<#base:DataType>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< 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. Binding: fhir-types (required, List of FHIR types (resources, data types).); (xsd)type:code>
[]< The profile of the required data, specified as the uri of the profile definition.; (xsd)profile:StructureDefinition*>*
< 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. Binding: participant-resource-types (extensible, The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.).); (xsd)subject:(<CodeableConcept>
|<Group>)>?
[]< 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 resolvable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details).; (xsd)mustSupport:string>*
[]< 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.; (xsd)codeFilter:DataRequirement.codeFilter>*
[]< 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.; (xsd)dateFilter:DataRequirement.dateFilter>*
[]< Value filters specify additional constraints on the data for elements other than code-valued or date-valued. Each value filter specifies an additional constraint on the data (i.e. valueFilters are AND'ed, not OR'ed).; (xsd)valueFilter:DataRequirement.valueFilter>*
< 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".; (xsd)limit:positiveInt>?
[]< 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.; (xsd)sort:DataRequirement.sort>*🔗 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(xsd)(doc)=
<#base:Element>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< The code-valued attribute of the filter. The specified path SHALL be a FHIRPath resolvable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details). Note that the index must be an integer constant. The path must resolve to an element of type code, Coding, or CodeableConcept. The path attribute contains a [Simple FHIRPath Subset](fhirpath.html#simple) that allows path traversal, but not calculation.; (xsd)path:string>?
< 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.; (xsd)searchParam:string>?
< 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.; (xsd)valueSet: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.; (xsd)code:Coding>*🔗 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(xsd)(doc)=
<#base:Element>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< The date-valued attribute of the filter. The specified path SHALL be a FHIRPath resolvable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details). Note that the index must be an integer constant. The path must resolve to an element of type date, dateTime, Period, Schedule, or Timing. The path attribute contains a [Simple FHIR Subset](fhirpath.html#simple) that allows path traversal, but not calculation.; (xsd)path:string>?
< 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.; (xsd)searchParam:string>?
(<valueDateTime:dateTime>
|<valueDuration:Duration>
|<valuePeriod:Period>)?🔗 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(xsd)(doc)=
<#base:Element>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< 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.; (xsd)path:string>
< The direction of the sort, ascending or descending. Binding: sort-direction (required, The possible sort directions, ascending or descending.); (xsd)direction:code>🔗 Value filters specify additional constraints on the data for elements other than code-valued or date-valued. Each value filter specifies an additional constraint on the data (i.e. valueFilters are AND'ed, not OR'ed).DataRequirement.valueFilter(xsd)(doc)=
<#base:Element>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< The attribute of the filter. The specified path SHALL be a FHIRPath resolvable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details). Note that the index must be an integer constant. The path must resolve to an element of a type that is comparable to the valueFilter.value[x] element for the filter. The path attribute contains a [Simple FHIR Subset](fhirpath.html#simple) that allows path traversal, but not calculation.; (xsd)path:string>?
< A search parameter defined on the specified type of the DataRequirement, and which searches on elements of a type compatible with the type of the valueFilter.value[x] for the filter.; (xsd)searchParam:string>?
< The comparator to be used to determine whether the value is matching. Binding: value-filter-comparator (required, Possible comparators for the valueFilter element.); (xsd)comparator:code>?
(<valueDateTime:dateTime>
|<valueDuration:Duration>
|<valuePeriod:Period>)?🔗 The base class for all re-useable types defined as part of the FHIR Specification.DataType(xsd)(doc)=
<#base:Element>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*🔗 A date or partial date (e.g. just year or year + month). There is no UTC offset. The format is a union of the schema types gYear, gYearMonth and date. Dates SHALL be valid dates.date(xsd)(doc)=
<#base:PrimitiveType>
< unique id for the element within a resource (for internal references); (xsd)id:string>?
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< The actual value; (xsd)value:date>?🔗 A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a UTC offset 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. UTC offset is allowed for dates and partial datesdateTime(xsd)(doc)=
<#base:PrimitiveType>
< unique id for the element within a resource (for internal references); (xsd)id:string>?
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< The actual value; (xsd)value:dateTime>?🔗 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(xsd)(doc)=
<#base:PrimitiveType>
< unique id for the element within a resource (for internal references); (xsd)id:string>?
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< The actual value; (xsd)value:decimal>?🔗 Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. Drug-drug interaction, Ineffective treatment frequency, Procedure-condition conflict, gaps in care, etc.DetectedIssue(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< Business identifier associated with the detected issue record.; (xsd)identifier:Identifier>*
< Indicates the status of the detected issue. This element is labeled as a modifier because the status contains the code entered-in-error that marks the issue as not currently valid. Binding: detectedissue-status (required, Indicates the status of the identified issue.); (xsd)status:code>
[]< A code that classifies the general type of detected issue. In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set. Binding: detectedissue-category (preferred, Codes for high level detected issue categories.); (xsd)category:CodeableConcept>*
< Identifies the specific type of issue identified. Binding: detectedissue-category (preferred, Codes identifying the type of detected issue; e.g. Drug-drug interaction, Timing issue, Duplicate therapy, etc.); (xsd)code:CodeableConcept>?
< Indicates the degree of importance associated with the identified issue based on the potential impact on the patient. Binding: detectedissue-severity (required, Indicates the potential degree of impact of the identified issue on the patient.); (xsd)severity:code>?
< Indicates the subject whose record the detected issue is associated with.; (xsd)subject:(<BiologicallyDerivedProduct>
|<Device>
|<Group>
|<Location>
|<Medication>
|<NutritionProduct>
|<Organization>
|<Patient>
|<Practitioner>
|<Procedure>
|<Substance>)>?
< The encounter during which this issue was detected. This will typically be the encounter the DetectedIssue was created during, but some DetectedIssues may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission lab tests).; (xsd)encounter:Encounter*>?
< The date or period when the detected issue was initially identified.; (xsd)identified:(<dateTime>
|<Period>)>?
< Individual or device responsible for the issue being raised. For example, a decision support application or a pharmacist conducting a medication review.; (xsd)author:(<Device>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>?
[]< Indicates the resource representing the current activity or proposed activity that is potentially problematic. There's an implicit constraint on the number of implicated resources based on DetectedIssue.type; e.g. For drug-drug, there would be more than one. For timing, there would typically only be one.; (xsd)implicated:Resource*>*
[]< Supporting evidence or manifestations that provide the basis for identifying the detected issue such as a GuidanceResponse or MeasureReport.; (xsd)evidence:DetectedIssue.evidence>*
< A textual explanation of the detected issue. Should focus on information not covered elsewhere as discrete data - no need to duplicate the narrative.; (xsd)detail:markdown>?
< The literature, knowledge-base or similar reference that describes the propensity for the detected issue identified.; (xsd)reference:uri>?
[]< Indicates an action that has been taken or is committed to reduce or eliminate the likelihood of the risk identified by the detected issue from manifesting. Can also reflect an observation of known mitigating factors that may reduce/eliminate the need for any action.; (xsd)mitigation:DetectedIssue.mitigation>*🔗 Supporting evidence or manifestations that provide the basis for identifying the detected issue such as a GuidanceResponse or MeasureReport.DetectedIssue.evidence(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< A manifestation that led to the recording of this detected issue. Binding: manifestation-or-symptom (example, Codes that describes the types of evidence for a detected issue.); (xsd)code:CodeableConcept>*
[]< Links to resources that constitute evidence for the detected issue such as a GuidanceResponse or MeasureReport.; (xsd)detail:Resource*>*🔗 Indicates an action that has been taken or is committed to reduce or eliminate the likelihood of the risk identified by the detected issue from manifesting. Can also reflect an observation of known mitigating factors that may reduce/eliminate the need for any action.DetectedIssue.mitigation(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Describes the action that was taken or the observation that was made that reduces/eliminates the risk associated with the identified issue. The "text" component can be used for detail or when no appropriate code exists. Binding: detectedissue-mitigation-action (preferred, Codes describing steps taken to resolve the issue or other circumstances that mitigate the risk associated with the issue; e.g. 'added concurrent therapy', 'prior therapy documented', etc.); (xsd)action:CodeableConcept>
< Indicates when the mitigating action was documented. This might not be the same as when the mitigating step was actually taken.; (xsd)date:dateTime>?
< Identifies the practitioner who determined the mitigation and takes responsibility for the mitigation step occurring.; (xsd)author:(<Practitioner>
|<PractitionerRole>)>?
[]< Clinicians may add additional notes or justifications about the mitigation action. For example, patient can have this drug because they have had it before without any issues. Multiple justifications may be provided.; (xsd)note:Annotation>*🔗 A type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device.Device(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< Unique instance identifiers assigned to a device by manufacturers other organizations or owners. Certain attributes, like serial number and UDI Carrier (the HRF or AIDC barcode string) are not device instance identifiers as they are not consistently able to uniquely identify the instance of a device, thus are not appropriate to be used to value Device.identifier. The barcode string from a barcode present on a device label or package may identify the instance, include names given to the device in local usage, or may identify the type of device. If the identifier identifies the type of device, Device.type element should be used. The identifier is typically valued if the serialNumber or lotNumber is not valued and represents a different type of identifier. However, it is permissible to still include those identifiers in DeviceDefinition.identifier with the appropriate identifier.type.; (xsd)identifier:Identifier>*
< The name used to display by default when the device is referenced. Based on intent of use by the resource creator, this may reflect one of the names in Device.name, or may be another simple name.; (xsd)displayName:string>?
< The reference to the definition for the device.; (xsd)definition:DeviceDefinition*>?
[]< Unique device identifier (UDI) assigned to device label or package. Note that the Device may include multiple udiCarriers as it either may include just the udiCarrier for the jurisdiction it is sold, or for multiple jurisdictions it could have been sold. UDI may identify an unique instance of a device, or it may only identify the type of the device. See [UDI mappings](device-mappings.html#udi) for a complete mapping of UDI parts to Device.; (xsd)udiCarrier:Device.udiCarrier>*
< The Device record status. This is not the status of the device like availability. Binding: device-status (required, The record status of the device.); (xsd)status:code>?
< The availability of the device. Binding: device-availability-status (extensible, The availability status reason of the device.); (xsd)availabilityStatus:CodeableConcept>?
< An identifier that supports traceability to the event during which material in this product from one or more biological entities was obtained or pooled. Necessary to support mandatory requirements for traceability from donor/source to recipient and vice versa, while also satisfying donor anonymity requirements. The element is defined consistently across BiologicallyDerivedProduct, NutritionProduct, and Device. The identifier references an event that links to a single biological entity such as a blood donor, or to multiple biological entities (e.g. when the product is an embryo or a pooled platelet product). A single biologicalSourceEvent identifier may appear on multiple products of many types derived from a single donation event or source extraction. As an example, a single donation event may provide 2 kidneys and a liver for organ transplantation, 2 corneas for eye surgery, heart valves and arterial tissue for cardiovascular surgery, multiple skin grafts, tendons, multiple shaped bone grafts and a large number of bone putty/paste products; and each of them may be assigned to the same biological source event identifier.; (xsd)biologicalSourceEvent:Identifier>?
< A name of the manufacturer or entity legally responsible for the device.; (xsd)manufacturer:string>?
< The date and time when the device was manufactured.; (xsd)manufactureDate:dateTime>?
< The date and time beyond which this device is no longer valid or should not be used (if applicable).; (xsd)expirationDate:dateTime>?
< Lot number assigned by the manufacturer.; (xsd)lotNumber:string>?
< The serial number assigned by the organization when the device was manufactured. Alphanumeric Maximum 20. While a serial number is a type of identifier, in the context of devices for which a UDI is required, thus a serial number may be part of the production identifier, it is more informative to have the serial number as a dedicated attribute together with the other UDI production identifier. When the device is not subject to including the UDI (e.g., its presence and exchange is not mandated by local regulatory requirements or specific use case at hand), thus the concept of production identifiers is not relevant as a set, it remains helpful for consistency to still use Device.serialNumber rather than using Device.identifier with an appropriate type. Systems that do not realize an identifier is a serial number may place it in Device.identifier or if the identifier.system is known for the serial number, it may also be populated in the Device.identifier as a globally unique id_.; (xsd)serialNumber:string>?
[]< This represents the manufacturer's name of the device as provided by the device, from a UDI label, or by a person describing the Device. This typically would be used when a person provides the name(s) or when the device represents one of the names available from DeviceDefinition.; (xsd)name:Device.name>*
< The manufacturer's model number for the device.; (xsd)modelNumber:string>?
< The part number or catalog number of the device. Alphanumeric Maximum 20.; (xsd)partNumber:string>?
[]< Devices may be associated with one or more categories. Binding: device-category (example, Categories of medical devices.); (xsd)category:CodeableConcept>*
[]< The kind or type of device. A device instance may have more than one type - in which case those are the types that apply to the specific instance of the device. Multiple device types are use when a device is categorized in more than one context – for example, hybrid devices in which the device is both of type gateway and sensor. Binding: device-type (example, Codes to identify medical devices.); (xsd)type:CodeableConcept>*
[]< The actual design of the device or software version running on the device.; (xsd)version:Device.version>*
[]< Identifies the standards, specifications, or formal guidances for the capabilities supported by the device. The device may be certified as conformant to these specifications e.g., communication, performance, process, measurement, or specialization standards.; (xsd)conformsTo:Device.conformsTo>*
[]< Static or essentially fixed characteristics or features of the device (e.g., time or timing attributes, resolution, accuracy, intended use or instructions for use, and physical attributes) that are not otherwise captured in more specific attributes. Dynamic or current properties, such as settings, of an individual device are described using a Device instance-specific [DeviceMetric] and recorded using [Observation]. Static characteristics of a device could also be documented in an associated [DeviceDefinition] instance. The Device instance's properties, and their values, could be, but need not be, the same as those described in an associated DeviceDefinition.; (xsd)property:Device.property>*
< The designated condition for performing a task with the device. Binding: device-operation-mode (example, Operational mode of a device.); (xsd)mode:CodeableConcept>?
< The series of occurrences that repeats during the operation of the device.; (xsd)cycle:Count>?
< A measurement of time during the device's operation (e.g., days, hours, mins, etc.).; (xsd)duration:Duration>?
< An organization that is responsible for the provision and ongoing maintenance of the device.; (xsd)owner:Organization*>?
[]< Contact details for an organization or a particular human that is responsible for the device. used for troubleshooting etc.; (xsd)contact:ContactPoint>*
< The place where the device can be found.; (xsd)location:Location*>?
< A network address on which the device may be contacted directly. If the device is running a FHIR server, the network address should be the Base URL from which a conformance statement may be retrieved.; (xsd)url:uri>?
[]< Technical endpoints providing access to services provided by the device defined at this resource.; (xsd)endpoint:Endpoint*>*
[]< The linked device acting as a communication controller, data collector, translator, or concentrator for the current device (e.g., mobile phone application that relays a blood pressure device's data). The Device.gateway may be used when the Device being referenced has a gateway and/or to capture one or more gateways associated with the device. If the Gateway is included in the Observation resource, the Observation.gatewayDevice should be used instead.; (xsd)gateway:Device*>*
[]< Descriptive information, usage information or implantation information that is not captured in an existing element.; (xsd)note:Annotation>*
[]< Provides additional safety characteristics about a medical device. For example devices containing latex. Binding: device-safety (example, ); (xsd)safety:CodeableConcept>*
< The higher level or encompassing device that this device is a logical part of. For example a vital signs monitor (parent) where three separate modules can be plugged into such as interchangeable blood pressure, oximeter, temperature modules. These modules are represented as devices with the .parent valued to the vital signs monitor when plugged in.; (xsd)parent:Device*>?🔗 Identifies the standards, specifications, or formal guidances for the capabilities supported by the device. The device may be certified as conformant to these specifications e.g., communication, performance, process, measurement, or specialization standards.Device.conformsTo(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Describes the type of the standard, specification, or formal guidance. Binding: device-specification-category (example, The kind of standards used by the device.); (xsd)category:CodeableConcept>?
< Code that identifies the specific standard, specification, protocol, formal guidance, regulation, legislation, or certification scheme to which the device adheres. Binding: device-specification-type (example, The type of version indicated for the device.); (xsd)specification:CodeableConcept>
< Identifies the specific form or variant of the standard, specification, or formal guidance. This may be a 'version number', release, document edition, publication year, or other label.; (xsd)version:string>?🔗 This represents the manufacturer's name of the device as provided by the device, from a UDI label, or by a person describing the Device. This typically would be used when a person provides the name(s) or when the device represents one of the names available from DeviceDefinition.Device.name(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The actual name that identifies the device.; (xsd)value:string>
< Indicates the kind of name. RegisteredName | UserFriendlyName | PatientReportedName. Binding: device-nametype (required, The type of name the device is referred by.); (xsd)type:code>
< Indicates the default or preferred name to be displayed.; (xsd)display:boolean>?🔗 Static or essentially fixed characteristics or features of the device (e.g., time or timing attributes, resolution, accuracy, intended use or instructions for use, and physical attributes) that are not otherwise captured in more specific attributes. Dynamic or current properties, such as settings, of an individual device are described using a Device instance-specific [DeviceMetric] and recorded using [Observation]. Static characteristics of a device could also be documented in an associated [DeviceDefinition] instance. The Device instance's properties, and their values, could be, but need not be, the same as those described in an associated DeviceDefinition.Device.property(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Code that specifies the property, such as resolution, color, size, being represented. Binding: device-property-type (example, Device property type.); (xsd)type:CodeableConcept>
(<valueAttachment:Attachment>
|<valueBoolean:boolean>
|<valueCodeableConcept:CodeableConcept>
|<valueInteger:integer>
|<valueQuantity:Quantity>
|<valueRange:Range>
|<valueString:string>)🔗 Unique device identifier (UDI) assigned to device label or package. Note that the Device may include multiple udiCarriers as it either may include just the udiCarrier for the jurisdiction it is sold, or for multiple jurisdictions it could have been sold. UDI may identify an unique instance of a device, or it may only identify the type of the device. See [UDI mappings](device-mappings.html#udi) for a complete mapping of UDI parts to Device.Device.udiCarrier(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The device identifier (DI) is a mandatory, fixed portion of a UDI that identifies the labeler and the specific version or model of a device.; (xsd)deviceIdentifier:string>
< Organization that is charged with issuing UDIs for devices. For example, the US FDA issuers include:
1) GS1: http://hl7.org/fhir/NamingSystem/gs1-di,
2) HIBCC: http://hl7.org/fhir/NamingSystem/hibcc-diI,
3) ICCBBA for blood containers: http://hl7.org/fhir/NamingSystem/iccbba-blood-di,
4) ICCBA for other devices: http://hl7.org/fhir/NamingSystem/iccbba-other-di # Informationsstelle für Arzneispezialitäten (IFA GmbH) (EU only): http://hl7.org/fhir/NamingSystem/ifa-gmbh-di.; (xsd)issuer:uri>
< The identity of the authoritative source for UDI generation within a jurisdiction. All UDIs are globally unique within a single namespace with the appropriate repository uri as the system. For example, UDIs of devices managed in the U.S. by the FDA, the value is http://hl7.org/fhir/NamingSystem/us-fda-udi or in the European Union by the European Commission http://hl7.org/fhir/NamingSystem/eu-ec-udi.; (xsd)jurisdiction:uri>?
< The full UDI carrier of the Automatic Identification and Data Capture (AIDC) technology representation of the barcode string as printed on the packaging of the device - e.g., a barcode or RFID. Because of limitations on character sets in XML and the need to round-trip JSON data through XML, AIDC Formats *SHALL* be base64 encoded. The AIDC form of UDIs should be scanned or otherwise used for the identification of the device whenever possible to minimize errors in records resulting from manual transcriptions. If separate barcodes for DI and PI are present, concatenate the string with DI first and in order of human readable expression on label.; (xsd)carrierAIDC:base64Binary>?
< The full UDI carrier as the human readable form (HRF) representation of the barcode string as printed on the packaging of the device. If separate barcodes for DI and PI are present, concatenate the string with DI first and in order of human readable expression on label.; (xsd)carrierHRF:string>?
< A coded entry to indicate how the data was entered. Binding: udi-entry-type (required, Codes to identify how UDI data was entered.); (xsd)entryType:code>?🔗 The actual design of the device or software version running on the device.Device.version(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The type of the device version, e.g. manufacturer, approved, internal. Binding: device-versiontype (example, The type of version indicated for the device.); (xsd)type:CodeableConcept>?
< The hardware or software module of the device to which the version applies. Note that the module of the device would not need to be tracked as a separate device, e.g., using different UDI, thus would typically involve one or more software modules. For example, a device may involve two software modules each on a different version.; (xsd)component:Identifier>?
< The date the version was installed on the device.; (xsd)installDate:dateTime>?
< The version text.; (xsd)value:string>🔗 A record of association or dissociation of a device with a patient.DeviceAssociation(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< Instance identifier.; (xsd)identifier:Identifier>*
< Reference to the devices associated with the patient or group.; (xsd)device:Device*>
[]< Describes the relationship between the device and subject.; (xsd)category:CodeableConcept>*
< Indicates the state of the Device association. Binding: deviceassociation-status (required, Describes the lifecycle of the association.); (xsd)status:CodeableConcept>
[]< The reasons given for the current association status. Binding: deviceassociation-status-reason (required, Describes the reason for changing the status of the association.); (xsd)statusReason:CodeableConcept>*
< The individual, group of individuals or device that the device is on or associated with.; (xsd)subject:(<Device>
|<Group>
|<Patient>
|<Practitioner>
|<RelatedPerson>)>?
< Current anatomical location of the device in/on subject.; (xsd)bodyStructure:BodyStructure*>?
< Begin and end dates and times for the device association.; (xsd)period:Period>?
[]< The details about the device when it is in use to describe its operation.; (xsd)operation:DeviceAssociation.operation>*🔗 The details about the device when it is in use to describe its operation.DeviceAssociation.operation(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Device operational condition corresponding to the association. Binding: deviceassociation-operationstatus (example, Describes the the status of the association operation.); (xsd)status:CodeableConcept>
[]< The individual performing the action enabled by the device.; (xsd)operator:(<Patient>
|<Practitioner>
|<RelatedPerson>)>*
< Begin and end dates and times for the device's operation.; (xsd)period:Period>?🔗 The characteristics, operational status and capabilities of a medical-related component of a medical device. For the initial scope, this DeviceDefinition resource is only applicable to describe a single node in the containment tree that is produced by the context scanner in any medical device that implements or derives from the ISO/IEEE 11073 standard and that does not represent a metric. Examples for such a node are MDS, VMD, or Channel.DeviceDefinition(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< Additional information to describe the device.; (xsd)description:markdown>?
[]< Unique instance identifiers assigned to a device by the software, manufacturers, other organizations or owners. For example: handle ID. The identifier is typically valued if the udiDeviceIdentifier, partNumber or modelNumber is not valued and represents a different type of identifier. However, it is permissible to still include those identifiers in DeviceDefinition.identifier with the appropriate identifier.type.; (xsd)identifier:Identifier>*
[]< Unique device identifier (UDI) assigned to device label or package. Note that the Device may include multiple udiCarriers as it either may include just the udiCarrier for the jurisdiction it is sold, or for multiple jurisdictions it could have been sold.; (xsd)udiDeviceIdentifier:DeviceDefinition.udiDeviceIdentifier>*
[]< Identifier associated with the regulatory documentation (certificates, technical documentation, post-market surveillance documentation and reports) of a set of device models sharing the same intended purpose, risk class and essential design and manufacturing characteristics. One example is the Basic UDI-DI in Europe. This should not be used for regulatory authorization numbers which are to be captured elsewhere.; (xsd)regulatoryIdentifier:DeviceDefinition.regulatoryIdentifier>*
< The part number or catalog number of the device. Alphanumeric Maximum 20.; (xsd)partNumber:string>?
< A name of the manufacturer or legal representative e.g. labeler. Whether this is the actual manufacturer or the labeler or responsible depends on implementation and jurisdiction.; (xsd)manufacturer:Organization*>?
[]< The name or names of the device as given by the manufacturer.; (xsd)deviceName:DeviceDefinition.deviceName>*
< The model number for the device for example as defined by the manufacturer or labeler, or other agency.; (xsd)modelNumber:string>?
[]< What kind of device or device system this is. In this element various classifications can be used, such as GMDN, EMDN, SNOMED CT, risk classes, national product codes.; (xsd)classification:DeviceDefinition.classification>*
[]< Identifies the standards, specifications, or formal guidances for the capabilities supported by the device. The device may be certified as conformant to these specifications e.g., communication, performance, process, measurement, or specialization standards.; (xsd)conformsTo:DeviceDefinition.conformsTo>*
[]< A device that is part (for example a component) of the present device.; (xsd)hasPart:DeviceDefinition.hasPart>*
[]< Information about the packaging of the device, i.e. how the device is packaged.; (xsd)packaging:DeviceDefinition.packaging>*
[]< The version of the device or software.; (xsd)version:DeviceDefinition.version>*
[]< Safety characteristics of the device. Binding: device-safety (example, ); (xsd)safety:CodeableConcept>*
[]< Shelf Life and storage information.; (xsd)shelfLifeStorage:ProductShelfLife>*
[]< Language code for the human-readable text strings produced by the device (all supported).; (xsd)languageCode:CodeableConcept>*
[]< Static or essentially fixed characteristics or features of this kind of device that are otherwise not captured in more specific attributes, e.g., time or timing attributes, resolution, accuracy, and physical attributes. Dynamic or current properties, such as settings, of an individual device are described using a Device instance-specific DeviceMetric and recorded using Observation. Static characteristics of an individual device could also be documented in a [Device] instance. The Device instance's properties, and their values, could be, but need not be, the same as in the associated DeviceDefinition.; (xsd)property:DeviceDefinition.property>*
< An organization that is responsible for the provision and ongoing maintenance of the device.; (xsd)owner:Organization*>?
[]< Contact details for an organization or a particular human that is responsible for the device. used for troubleshooting etc.; (xsd)contact:ContactPoint>*
[]< An associated device, attached to, used with, communicating with or linking a previous or new device model to the focal device.; (xsd)link:DeviceDefinition.link>*
[]< Descriptive information, usage information or implantation information that is not captured in an existing element.; (xsd)note:Annotation>*
[]< A substance used to create the material(s) of which the device is made.; (xsd)material:DeviceDefinition.material>*
[]< Indicates the production identifier(s) that are expected to appear in the UDI carrier on the device label. Binding: device-productidentifierinudi (required, The production identifier(s) that are expected to appear in the UDI carrier.); (xsd)productionIdentifierInUDI:code>*
< Information aimed at providing directions for the usage of this model of device. For more structured data, a ClinicalUseDefinition that points to the DeviceDefinition can be used.; (xsd)guideline:DeviceDefinition.guideline>?
< Tracking of latest field safety corrective action.; (xsd)correctiveAction:DeviceDefinition.correctiveAction>?
[]< Billing code or reference associated with the device.; (xsd)chargeItem:DeviceDefinition.chargeItem>*🔗 What kind of device or device system this is. In this element various classifications can be used, such as GMDN, EMDN, SNOMED CT, risk classes, national product codes.DeviceDefinition.classification(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A classification or risk class of the device model. Binding: device-type (example, Type of device e.g. according to official classification.); (xsd)type:CodeableConcept>
[]< Further information qualifying this classification of the device model.; (xsd)justification:RelatedArtifact>*🔗 Identifies the standards, specifications, or formal guidances for the capabilities supported by the device. The device may be certified as conformant to these specifications e.g., communication, performance, process, measurement, or specialization standards.DeviceDefinition.conformsTo(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Describes the type of the standard, specification, or formal guidance. Binding: device-specification-category (example, ); (xsd)category:CodeableConcept>?
< Code that identifies the specific standard, specification, protocol, formal guidance, regulation, legislation, or certification scheme to which the device adheres. Binding: device-specification-type (example, ); (xsd)specification:CodeableConcept>
[]< Identifies the specific form or variant of the standard, specification, or formal guidance. This may be a 'version number', release, document edition, publication year, or other label.; (xsd)version:string>*
[]< Standard, regulation, certification, or guidance website, document, or other publication, or similar, supporting the conformance.; (xsd)source:RelatedArtifact>*🔗 Tracking of latest field safety corrective action.DeviceDefinition.correctiveAction(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Whether the last corrective action known for this device was a recall. When a field safety action has been initiated but not yet resulted in a recall, this element will be set to 'false'.; (xsd)recall:boolean>
< The scope of the corrective action - whether the action targeted all units of a given device model, or only a specific set of batches identified by lot numbers, or individually identified devices identified by the serial name. Binding: device-correctiveactionscope (required, The type or scope of the corrective action.); (xsd)scope:code>?
< Start and end dates of the corrective action.; (xsd)period:Period>🔗 The name or names of the device as given by the manufacturer.DeviceDefinition.deviceName(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A human-friendly name that is used to refer to the device - depending on the type, it can be the brand name, the common name or alias, or other.; (xsd)name:string>
< The type of deviceName.
RegisteredName | UserFriendlyName | PatientReportedName. Binding: device-nametype (required, The type of name the device is referred by.); (xsd)type:code>🔗 Information aimed at providing directions for the usage of this model of device. For more structured data, a ClinicalUseDefinition that points to the DeviceDefinition can be used.DeviceDefinition.guideline(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< The circumstances that form the setting for using the device.; (xsd)useContext:UsageContext>*
< Detailed written and visual directions for the user on how to use the device.; (xsd)usageInstruction:markdown>?
[]< A source of information or reference for this guideline.; (xsd)relatedArtifact:RelatedArtifact>*
[]< A clinical condition for which the device was designed to be used. A ClinicalUseDefinition that points to the DeviceDefinition can be used if more structured data is needed.; (xsd)indication:CodeableConcept>*
[]< A specific situation when a device should not be used because it may cause harm. A ClinicalUseDefinition that points to the DeviceDefinition can be used if more structured data is needed.; (xsd)contraindication:CodeableConcept>*
[]< Specific hazard alert information that a user needs to know before using the device. A ClinicalUseDefinition that points to the DeviceDefinition can be used if more structured data is needed.; (xsd)warning:CodeableConcept>*
< A description of the general purpose or medical use of the device or its function.; (xsd)intendedUse:string>?🔗 A device that is part (for example a component) of the present device.DeviceDefinition.hasPart(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Reference to the device that is part of the current device.; (xsd)reference:DeviceDefinition*>
< Number of instances of the component device in the current device.; (xsd)count:integer>?🔗 Billing code or reference associated with the device.DeviceDefinition.chargeItem(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The code or reference for the charge item.; (xsd)chargeItemCode:ChargeItemDefinition*>
< Coefficient applicable to the billing code.; (xsd)count:Quantity>
< A specific time period in which this charge item applies.; (xsd)effectivePeriod:Period>?
[]< The context to which this charge item applies.; (xsd)useContext:UsageContext>*🔗 An associated device, attached to, used with, communicating with or linking a previous or new device model to the focal device.DeviceDefinition.link(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The type indicates the relationship of the related device to the device instance. Binding: devicedefinition-relationtype (extensible, The type of relation between this and the linked device.); (xsd)relation:Coding>
< A reference to the linked device.; (xsd)relatedDevice:DeviceDefinition*>🔗 A substance used to create the material(s) of which the device is made.DeviceDefinition.material(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A substance that the device contains, may contain, or is made of - for example latex - to be used to determine patient compatibility. This is not intended to represent the composition of the device, only the clinically relevant materials.; (xsd)substance:CodeableConcept>
< Indicates an alternative material of the device.; (xsd)alternate:boolean>?
< Whether the substance is a known or suspected allergen.; (xsd)allergenicIndicator:boolean>?🔗 Information about the packaging of the device, i.e. how the device is packaged.DeviceDefinition.packaging(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The business identifier of the packaged medication.; (xsd)identifier:Identifier>?
< A code that defines the specific type of packaging.; (xsd)type:CodeableConcept>?
< The number of items contained in the package (devices or sub-packages).; (xsd)count:integer>?
[]< An organization that distributes the packaged device.; (xsd)distributor:DeviceDefinition.packaging.distributor>*
[]< Unique Device Identifier (UDI) Barcode string on the packaging.; (xsd)udiDeviceIdentifier:DeviceDefinition.udiDeviceIdentifier>*
[]< Allows packages within packages.; (xsd)packaging:DeviceDefinition.packaging>*🔗 An organization that distributes the packaged device.DeviceDefinition.packaging.distributor(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Distributor's human-readable name.; (xsd)name:string>?
[]< Distributor as an Organization resource.; (xsd)organizationReference:Organization*>*🔗 Static or essentially fixed characteristics or features of this kind of device that are otherwise not captured in more specific attributes, e.g., time or timing attributes, resolution, accuracy, and physical attributes. Dynamic or current properties, such as settings, of an individual device are described using a Device instance-specific DeviceMetric and recorded using Observation. Static characteristics of an individual device could also be documented in a [Device] instance. The Device instance's properties, and their values, could be, but need not be, the same as in the associated DeviceDefinition.DeviceDefinition.property(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Code that specifies the property such as a resolution or color being represented. Binding: device-property-type (example, Device property type.); (xsd)type:CodeableConcept>
(<valueAttachment:Attachment>
|<valueBoolean:boolean>
|<valueCodeableConcept:CodeableConcept>
|<valueInteger:integer>
|<valueQuantity:Quantity>
|<valueRange:Range>
|<valueString:string>)🔗 Identifier associated with the regulatory documentation (certificates, technical documentation, post-market surveillance documentation and reports) of a set of device models sharing the same intended purpose, risk class and essential design and manufacturing characteristics. One example is the Basic UDI-DI in Europe. This should not be used for regulatory authorization numbers which are to be captured elsewhere.DeviceDefinition.regulatoryIdentifier(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The type of identifier itself. Binding: devicedefinition-regulatory-identifier-type (required, Device regulatory identifier type.); (xsd)type:code>
< The identifier itself.; (xsd)deviceIdentifier:string>
< The organization that issued this identifier.; (xsd)issuer:uri>
< The jurisdiction to which the deviceIdentifier applies.; (xsd)jurisdiction:uri>🔗 Unique device identifier (UDI) assigned to device label or package. Note that the Device may include multiple udiCarriers as it either may include just the udiCarrier for the jurisdiction it is sold, or for multiple jurisdictions it could have been sold.DeviceDefinition.udiDeviceIdentifier(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The identifier that is to be associated with every Device that references this DeviceDefintiion for the issuer and jurisdiction provided in the DeviceDefinition.udiDeviceIdentifier.; (xsd)deviceIdentifier:string>
< The organization that assigns the identifier algorithm.; (xsd)issuer:uri>
< The jurisdiction to which the deviceIdentifier applies.; (xsd)jurisdiction:uri>
[]< Indicates where and when the device is available on the market.; (xsd)marketDistribution:DeviceDefinition.udiDeviceIdentifier.marketDistribution>*🔗 Indicates where and when the device is available on the market.DeviceDefinition.udiDeviceIdentifier.marketDistribution(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Begin and end dates for the commercial distribution of the device.; (xsd)marketPeriod:Period>
< National state or territory to which the marketDistribution recers, typically where the device is commercialized.; (xsd)subJurisdiction:uri>🔗 The version of the device or software.DeviceDefinition.version(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The type of the device version, e.g. manufacturer, approved, internal.; (xsd)type:CodeableConcept>?
< The hardware or software module of the device to which the version applies. Note that the module of the device would not need to be tracked as a separate device, e.g., using different UDI, thus would typically involve one or more software modules. For example, a device may involve two software modules each on a different version.; (xsd)component:Identifier>?
< The version text.; (xsd)value:string>🔗 A record of dispensation of a device - i.e., assigning a device to a patient, or to a professional for their use.DeviceDispense(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< Business identifier for this dispensation. This is a business identifier, not a resource identifier.; (xsd)identifier:Identifier>*
[]< The order or request that this dispense is fulfilling.; (xsd)basedOn:(<CarePlan>
|<DeviceRequest>)>*
[]< The bigger event that this dispense is a part of.; (xsd)partOf:Procedure*>*
< A code specifying the state of the set of dispense events. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. Binding: devicedispense-status (required, Describes the lifecycle of the dispense.); (xsd)status:code>
< Indicates the reason why a dispense was or was not performed. Binding: devicedispense-status-reason (example, A code describing why a dispense was or was not performed.); (xsd)statusReason:DetectedIssue*>?
[]< Indicates the type of device dispense. The category can be used to include where the device is expected to be consumed or other types of dispenses. Invariants can be used to bind to different value sets when profiling to bind.; (xsd)category:CodeableConcept>*
< Identifies the device being dispensed. This is either a link to a resource representing the details of the device or a simple attribute carrying a code that identifies the device from a known list of devices.; (xsd)device:(<Device>
|<DeviceDefinition>)>
< A link to a resource representing the person to whom the device is intended. What about 'this measuring Device is now asigned to Dr X who needs it now'?; (xsd)subject:(<Patient>
|<Practitioner>)>
< Identifies the person who picked up the device or the person or location where the device was delivered. This may be a patient or their caregiver, but some cases exist where it can be a healthcare professional or a location.; (xsd)receiver:(<Location>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>?
< The encounter that establishes the context for this event.; (xsd)encounter:Encounter*>?
[]< Additional information that supports the device being dispensed.; (xsd)supportingInformation:Resource*>*
[]< Indicates who or what performed the event.; (xsd)performer:DeviceDispense.performer>*
< The principal physical location where the dispense was performed.; (xsd)location:Location*>?
< Indicates the type of dispensing event that is performed.; (xsd)type:CodeableConcept>?
< The number of devices that have been dispensed.; (xsd)quantity:SimpleQuantity>?
< The time when the dispensed product was packaged and reviewed.; (xsd)preparedDate:dateTime>?
< The time the dispensed product was made available to the patient or their representative.; (xsd)whenHandedOver:dateTime>?
< Identification of the facility/location where the device was /should be shipped to, as part of the dispense process.; (xsd)destination:Location*>?
[]< Extra information about the dispense that could not be conveyed in the other attributes.; (xsd)note:Annotation>*
< The full representation of the instructions. The content of the renderedDosageInstructions must not be different than the dose represented in the dosageInstruction content.; (xsd)usageInstruction:markdown>?
[]< A summary of the events of interest that have occurred, such as when the dispense was verified. This might not include provenances for all versions of the request – only those deemed “relevant” or important. This SHALL NOT include the Provenance associated with this current version of the resource. (If that provenance is deemed to be a “relevant” change, it will need to be added as part of a later update. Until then, it can be queried directly as the Provenance that points to this version using _revinclude All Provenances should have some historical version of this Request as their subject.).; (xsd)eventHistory:Provenance*>*🔗 Indicates who or what performed the event.DeviceDispense.performer(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Distinguishes the type of performer in the dispense. For example, date enterer, packager, final checker.; (xsd)function:CodeableConcept>?
< The device, practitioner, etc. who performed the action. It should be assumed that the actor is the dispenser of the device.; (xsd)actor:(<CareTeam>
|<Device>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>🔗 Describes a measurement, calculation or setting capability of a device. The DeviceMetric resource is derived from the ISO/IEEE 11073-10201 Domain Information Model standard, but is more widely applicable.DeviceMetric(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< Instance identifiers assigned to a device, by the device or gateway software, manufacturers, other organizations or owners. For example, handle ID. For identifiers assigned to a device by the device or gateway software, the `system` element of the identifier should be set to any identifier of the device.; (xsd)identifier:Identifier>*
< Describes the type of the metric. For example: Heart Rate, PEEP Setting, etc. DeviceMetric.type can be referred to either IEEE 11073-10101 or LOINC. Binding: devicemetric-type (preferred, IEEE 11073-10101); (xsd)type:CodeableConcept>
< Describes the unit that an observed value determined for this metric will have. For example: Percent, Seconds, etc. DeviceMetric.unit can refer to either UCUM or preferable a RTMMS coding system. Binding: ucum-units (preferred, IEEE 11073-10101); (xsd)unit:CodeableConcept>?
< Describes the link to the Device. This is also known as a channel device. Note if this is not the top level device - also know as the source device, it may be referenced in the device.parent element.; (xsd)device:Device*>
< Indicates current operational state of the device. For example: On, Off, Standby, etc. Binding: metric-operational-status (required, Describes the operational status of the DeviceMetric.); (xsd)operationalStatus:code>?
< The preferred color associated with the metric (e.g., display color). This is often used to aid clinicians to track and identify parameter types by color. In practice, consider a Patient Monitor that has ECG/HR and Pleth; the metrics are displayed in different characteristic colors, such as HR in blue, BP in green, and PR and SpO2 in magenta. Binding: color-codes (required, Describes the typical color of representation.); (xsd)color:code>?
< Indicates the category of the observation generation process. A DeviceMetric can be for example a setting, measurement, or calculation. Binding: metric-category (required, Describes the category of the metric.); (xsd)category:code>
< The frequency at which the metric is taken or recorded. Devices measure metrics at a wide range of frequencies; for example, an ECG might sample measurements in the millisecond range, while an NIBP might trigger only once an hour. Less often, the measurementFrequency may be based on a unit other than time, such as distance (e.g. for a measuring wheel). The update period may be different than the measurement frequency, if the device does not update the published observed value with the same frequency as it was measured.; (xsd)measurementFrequency:Quantity>?
[]< Describes the calibrations that have been performed or that are required to be performed.; (xsd)calibration:DeviceMetric.calibration>*🔗 Describes the calibrations that have been performed or that are required to be performed.DeviceMetric.calibration(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Describes the type of the calibration method. Binding: metric-calibration-type (required, Describes the type of a metric calibration.); (xsd)type:code>?
< Describes the state of the calibration. Binding: metric-calibration-state (required, Describes the state of a metric calibration.); (xsd)state:code>?
< Describes the time last calibration has been performed.; (xsd)time:instant>?🔗 Measurements and simple assertions made about a patient, device or other subject. Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as laboratory reports, etc.devicemetricobservation(xsd)(doc)=
<#base:Observation>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< A unique identifier assigned to this observation.; (xsd)identifier:Identifier>*
< The reference to a FHIR ObservationDefinition resource that provides the definition that is adhered to in whole or in part by this Observation instance. ObservationDefinition can be referenced by its canonical url using instantiatesCanonical, or by a name or an identifier using the appropriate sub-elements of instantiatesReference.; (xsd)instantiates:ObservationDefinition*>?
[]< A plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed.; (xsd)basedOn:(<CarePlan>
|<DeviceRequest>
|<ImmunizationRecommendation>
|<MedicationRequest>
|<NutritionOrder>
|<ServiceRequest>)>*
[]< Identifies the observation(s) that triggered the performance of this observation.; (xsd)triggeredBy:devicemetricobservation.triggeredBy>*
[]< A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure. To link an Observation to an Encounter use `encounter`. See the [Notes](observation.html#obsgrouping) below for guidance on referencing another Observation.; (xsd)partOf:(<GenomicStudy>
|<ImagingStudy>
|<Immunization>
|<MedicationAdministration>
|<MedicationDispense>
|<MedicationStatement>
|<Procedure>)>*
< The status of the result value. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. Binding: observation-status (required, Codes providing the status of an observation.); (xsd)status:code>
[]< A code that classifies the general type of observation being made. In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set. Binding: observation-category (preferred, Codes for high level observation categories.); (xsd)category:CodeableConcept>*
< Describes what was observed. Sometimes this is called the observation "name". *All* code-value and, if present, component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. Binding: observation-codes (example, Codes identifying names of simple observations.); (xsd)code:CodeableConcept>
< The patient, or group of patients, location, device, organization, procedure or practitioner this observation is about and into whose or what record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the `focus` element or the `code` itself specifies the actual focus of the observation. One would expect this element to be a cardinality of 1..1. The only circumstance in which the subject can be missing is when the observation is made by a device that does not know the patient. In this case, the observation SHALL be matched to a patient through some context/channel matching technique, and at this point, the observation should be updated. The subject of an Observation may in some cases be a procedure. This supports the regulatory inspection use case where observations are captured during inspections of a procedure that is being performed (independent of any particular patient or whether patient related at all).; (xsd)subject:(<Device>
|<Patient>)>
[]< The actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also be an existing condition, an intervention, the subject's diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child's tracheostomy tube. In this example, the child is the patient of record and the mother is the focus. Typically, an observation is made about the subject - a patient, or group of patients, location, or device - and the distinction between the subject and what is directly measured for an observation is specified in the observation code itself ( e.g., "Blood Glucose") and does not need to be represented separately using this element. Use `specimen` if a reference to a specimen is required. If a code is required instead of a resource use either `bodysite` for bodysites or the standard extension [http://hl7.org/fhir/StructureDefinition/observation-focusCode](http://hl7.org/fhir/extensions/StructureDefinition-observation-focusCode.html).; (xsd)focus:Resource*>*
< The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made. This will typically be the encounter the event occurred within, but some events may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission laboratory tests).; (xsd)encounter:Encounter*>{0,0}
< The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the "physiologically relevant time". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself. At least a date should be present unless this observation is a historical report. For recording imprecise or "fuzzy" times (For example, a blood glucose measurement taken "after breakfast") use the [Timing](datatypes.html#timing) datatype which allow the measurement to be tied to regular life events.; (xsd)effective:dateTime>
< The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified. For Observations that don't require review and verification, it may be the same as the [`lastUpdated` ](resource-definitions.html#Meta.lastUpdated) time of the resource itself. For Observations that do require review and verification for certain updates, it might not be the same as the `lastUpdated` time of the resource itself due to a non-clinically significant update that doesn't require the new version to be reviewed and verified again.; (xsd)issued:instant>{0,0}
[]< Who was responsible for asserting the observed value as "true".; (xsd)performer:(<CareTeam>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>*
(<valueCodeableConcept:CodeableConcept>
|<valueDateTime:dateTime>
|<valuePeriod:Period>
|<valueQuantity:Quantity>
|<valueRange:Range>
|<valueRatio:Ratio>
|<valueSampledData:SampledData>
|<valueString:string>
|<valueTime:time>)?
< Provides a reason why the expected value in the element Observation.value[x] is missing. Null or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be "detected", "not detected", "inconclusive", or "specimen unsatisfactory".
The alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code "error" could be used when the measurement was not completed. Note that an observation may only be reported if there are values to report. For example differential cell counts values may be reported only when > 0. Because of these options, use-case agreements are required to interpret general observations for null or exceptional values. Binding: data-absent-reason (extensible, Codes specifying why the result (`Observation.value[x]`) is missing.); (xsd)dataAbsentReason:CodeableConcept>{0,0}
< A categorical assessment of an observation value. For example, high, low, normal. Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Binding: observation-interpretation (extensible, Codes identifying interpretations of observations.); (xsd)interpretation:CodeableConcept>?
[]< Comments about the observation or the results. May include general statements about the observation, or statements about significant, unexpected or unreliable results values, or information about its source when relevant to its interpretation.; (xsd)note:Annotation>*
< Indicates the site on the subject's body where the observation was made (i.e. the target site). Only used if not implicit in code found in Observation.code. In many systems, this may be represented as a related observation instead of an inline component. Binding: body-site (example, SNOMED CT Body site concepts); (xsd)bodySite:CodeableConcept>?
< Indicates the body structure on the subject's body where the observation was made (i.e. the target site). Only used if not implicit in code found in Observation.code or bodySite is used. In many systems, this may be represented as a related observation instead of an inline component.; (xsd)bodyStructure:BodyStructure*>?
< Indicates the mechanism used to perform the observation. Only used if not implicit in code for Observation.code. Binding: observation-methods (example, Methods for simple observations.); (xsd)method:CodeableConcept>?
< The specimen that was used when this observation was made. Should only be used if not implicit in code found in `Observation.code`. Observations are not made on specimens themselves; they are made on a subject, but in many cases by the means of a specimen. Note that although specimens are often involved, they are not always tracked and reported explicitly. Also note that observation resources may be used in contexts that track the specimen explicitly (e.g. Diagnostic Report).; (xsd)specimen:Specimen*>{0,0}
< A reference to the device that generates the measurements or the device settings for the device. Note that this is not meant to represent a device involved in the transmission of the result, e.g., a gateway. Such devices may be documented using the Provenance resource where relevant.; (xsd)device:DeviceMetric*>
< Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an "OR". In other words, to represent two distinct target populations, two `referenceRange` elements would be used. Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.; (xsd)referenceRange:devicemetricobservation.referenceRange>?
[]< This observation is a group observation (e.g. a battery, a panel of tests, a set of vital sign measurements) that includes the target as a member of the group. When using this element, an observation will typically have either a value or a set of related resources, although both may be present in some cases. For a discussion on the ways Observations can assembled in groups together, see [Notes](observation.html#obsgrouping) below. Note that a system may calculate results from [QuestionnaireResponse](questionnaireresponse.html) into a final score and represent the score as an Observation.; (xsd)hasMember:Observation*>*
[]< The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image. All the reference choices that are listed in this element can represent clinical observations and other measurements that may be the source for a derived value. The most common reference will be another Observation. For a discussion on the ways Observations can assembled in groups together, see [Notes](observation.html#obsgrouping) below.; (xsd)derivedFrom:Observation*>*
[]< Some observations have multiple component observations. These component observations are expressed as separate code value pairs that share the same attributes. Examples include systolic and diastolic component observations for blood pressure measurement and multiple component observations for genetics observations. For a discussion on the ways Observations can be assembled in groups together see [Notes](observation.html#notes) below.; (xsd)component:devicemetricobservation.component>*
< The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the "physiologically relevant time". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself. At least a date should be present unless this observation is a historical report. For recording imprecise or "fuzzy" times (For example, a blood glucose measurement taken "after breakfast") use the [Timing](datatypes.html#timing) datatype which allow the measurement to be tied to regular life events.; (xsd)effectiveDateTime:dateTime>🔗 Some observations have multiple component observations. These component observations are expressed as separate code value pairs that share the same attributes. Examples include systolic and diastolic component observations for blood pressure measurement and multiple component observations for genetics observations. For a discussion on the ways Observations can be assembled in groups together see [Notes](observation.html#notes) below.devicemetricobservation.component(xsd)(doc)=
<#base:Observation.component>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Describes what was observed. Sometimes this is called the observation "code". *All* code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. Binding: observation-codes (example, Codes identifying names of simple observations.); (xsd)code:CodeableConcept>
(<valueAttachment:Attachment>
|<valueBoolean:boolean>
|<valueCodeableConcept:CodeableConcept>
|<valueDateTime:dateTime>
|<valueInteger:integer>
|<valueMolecularSequence:MolecularSequence>
|<valuePeriod:Period>
|<valueQuantity:Quantity>
|<valueRange:Range>
|<valueRatio:Ratio>
|<valueSampledData:SampledData>
|<valueString:string>
|<valueTime:time>)?
< Provides a reason why the expected value in the element Observation.component.value[x] is missing. "Null" or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be "detected", "not detected", "inconclusive", or "test not done".
The alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code "error" could be used when the measurement was not completed. Because of these options, use-case agreements are required to interpret general observations for exceptional values. Binding: data-absent-reason (extensible, Codes specifying why the result (`Observation.value[x]`) is missing.); (xsd)dataAbsentReason:CodeableConcept>?
[]< A categorical assessment of an observation value. For example, high, low, normal. Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Binding: observation-interpretation (extensible, Codes identifying interpretations of observations.); (xsd)interpretation:CodeableConcept>*
[]< Guidance on how to interpret the value by comparison to a normal or recommended range. Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.; (xsd)referenceRange:Observation.referenceRange>*🔗 Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an "OR". In other words, to represent two distinct target populations, two `referenceRange` elements would be used. Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.devicemetricobservation.referenceRange(xsd)(doc)=
<#base:Observation.referenceRange>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The value of the low bound of the reference range. The low bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the low bound is omitted, it is assumed to be meaningless (e.g. reference range is <=2.3).; (xsd)low:SimpleQuantity>?
< The value of the high bound of the reference range. The high bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the high bound is omitted, it is assumed to be meaningless (e.g. reference range is >= 2.3).; (xsd)high:SimpleQuantity>?
< The value of the normal value of the reference range. Binding: observation-referencerange-normalvalue (extensible, Codes identifying the normal value of the observation.); (xsd)normalValue:CodeableConcept>?
< Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range. This SHOULD be populated if there is more than one range. If this element is not present then the normal range is assumed. Binding: referencerange-meaning (preferred, Code for the meaning of a reference range.); (xsd)type:CodeableConcept>?
[]< Codes to indicate the target population this reference range applies to. For example, a reference range may be based on the normal population or a particular sex or race. Multiple `appliesTo` are interpreted as an "AND" of the target populations. For example, to represent a target population of African American females, both a code of female and a code for African American would be used. This SHOULD be populated if there is more than one range. If this element is not present then the normal population is assumed. Binding: referencerange-appliesto (example, Codes identifying the population the reference range applies to.); (xsd)appliesTo:CodeableConcept>*
< The age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so.; (xsd)age:Range>?
< Text based reference range in an observation which may be used when a quantitative range is not appropriate for an observation. An example would be a reference value of "Negative" or a list or table of "normals".; (xsd)text:markdown>?🔗 Identifies the observation(s) that triggered the performance of this observation.devicemetricobservation.triggeredBy(xsd)(doc)=
<#base:Observation.triggeredBy>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Reference to the triggering observation.; (xsd)observation:Observation*>
< The type of trigger.
Reflex | Repeat | Re-run. Binding: observation-triggeredbytype (required, The type of TriggeredBy Observation.); (xsd)type:code>
< Provides the reason why this observation was performed as a result of the observation(s) referenced.; (xsd)reason:string>?🔗 The characteristics, operational status and capabilities of a medical-related component of a medical device. For the initial scope, this DeviceDefinition resource is only applicable to describe a single node in the containment tree that is produced by the context scanner in any medical device that implements or derives from the ISO/IEEE 11073 standard and that does not represent a metric. Examples for such a node are MDS, VMD, or Channel.DeviceModel(xsd)(doc)=
<#base:DeviceDefinition>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< An Extension; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< Additional information to describe the device.; (xsd)description:markdown>?
[]< This repeatable element is used in catalogs of devices to convey any kind of identifier assigned to the model of device, other than the primary UDI DI.
identifier may convey for instance, the secondary UDI-DI, the direct-marking UDI-DI, the unit-of-use UDI-DI or any additional non-UDI identifier.; (xsd)identifier:Identifier>*
[]< Unique device identifier (UDI) assigned to device label or package. Note that the Device may include multiple udiCarriers as it either may include just the udiCarrier for the jurisdiction it is sold, or for multiple jurisdictions it could have been sold.; (xsd)udiDeviceIdentifier:DeviceModel.udiDeviceIdentifier>*
[]< Identifier associated with the regulatory documentation (certificates, technical documentation, post-market surveillance documentation and reports) of a set of device models sharing the same intended purpose, risk class and essential design and manufacturing characteristics. One example is the Basic UDI-DI in Europe. This should not be used for regulatory authorization numbers which are to be captured elsewhere.; (xsd)regulatoryIdentifier:DeviceModel.regulatoryIdentifier>*
< The part number or catalog number of the device. Alphanumeric Maximum 20.; (xsd)partNumber:string>?
< A name of the manufacturer or legal representative e.g. labeler. Whether this is the actual manufacturer or the labeler or responsible depends on implementation and jurisdiction.; (xsd)manufacturer:Organization*>?
[]< The name or names of the device as given by the manufacturer.; (xsd)deviceName:DeviceModel.deviceName>*
< The model number for the device for example as defined by the manufacturer or labeler, or other agency.; (xsd)modelNumber:string>?
[]< What kind of device or device system this is. In this element various classifications can be used, such as GMDN, EMDN, SNOMED CT, risk classes, national product codes.; (xsd)classification:DeviceModel.classification>*
[]< Identifies the standards, specifications, or formal guidances for the capabilities supported by the device. The device may be certified as conformant to these specifications e.g., communication, performance, process, measurement, or specialization standards.; (xsd)conformsTo:DeviceModel.conformsTo>*
[]< A device that is part (for example a component) of the present device.; (xsd)hasPart:DeviceModel.hasPart>*
[]< Information about the packaging of the device, i.e. how the device is packaged.; (xsd)packaging:DeviceModel.packaging>*
[]< The version of the device or software.; (xsd)version:DeviceModel.version>*
[]< Safety characteristics of the device. Binding: device-safety (example, ); (xsd)safety:CodeableConcept>*
[]< Shelf Life and storage information.; (xsd)shelfLifeStorage:ProductShelfLife>*
[]< Language code for the human-readable text strings produced by the device (all supported).; (xsd)languageCode:CodeableConcept>*
[]< Static or essentially fixed characteristics or features of this kind of device that are otherwise not captured in more specific attributes, e.g., time or timing attributes, resolution, accuracy, and physical attributes. Dynamic or current properties, such as settings, of an individual device are described using a Device instance-specific DeviceMetric and recorded using Observation. Static characteristics of an individual device could also be documented in a [Device] instance. The Device instance's properties, and their values, could be, but need not be, the same as in the associated DeviceDefinition.; (xsd)property:DeviceModel.property>*
< An organization that is responsible for the provision and ongoing maintenance of the device.; (xsd)owner:Organization*>?
[]< Contact details for an organization or a particular human that is responsible for the device. used for troubleshooting etc.; (xsd)contact:ContactPoint>*
[]< An associated device, attached to, used with, communicating with or linking a previous or new device model to the focal device.; (xsd)link:DeviceModel.link>*
[]< Descriptive information, usage information or implantation information that is not captured in an existing element.; (xsd)note:Annotation>*
[]< A substance used to create the material(s) of which the device is made.; (xsd)material:DeviceModel.material>*
[]< Indicates the production identifier(s) that are expected to appear in the UDI carrier on the device label. Binding: device-productidentifierinudi (required, The production identifier(s) that are expected to appear in the UDI carrier.); (xsd)productionIdentifierInUDI:code>*
< Information aimed at providing directions for the usage of this model of device. For more structured data, a ClinicalUseDefinition that points to the DeviceDefinition can be used.; (xsd)guideline:DeviceModel.guideline>?
< Tracking of latest field safety corrective action.; (xsd)correctiveAction:DeviceModel.correctiveAction>?
[]< Billing code or reference associated with the device.; (xsd)chargeItem:DeviceModel.chargeItem>*
[]< This extension to PlanDefinition, MedicationKnowledge and DeviceDefinition conveys the reference to a catalog containing the extended resource; (xsd)CatalogReference>*
[]< Global Medical Device Nomenclature classification In this element various classifications can be used, such as GMDN, EMDN, SNOMED CT, risk classes, national product codes.; (xsd)gmdn:DeviceModel.gmdn>*
< Systematized nomenclature of medicine - clinical terms In this element various classifications can be used, such as GMDN, EMDN, SNOMED CT, risk classes, national product codes.; (xsd)snomed:DeviceModel.snomed>?
< European Medical Device Nomenclature In this element various classifications can be used, such as GMDN, EMDN, SNOMED CT, risk classes, national product codes.; (xsd)emdn:DeviceModel.emdn>?🔗 What kind of device or device system this is. In this element various classifications can be used, such as GMDN, EMDN, SNOMED CT, risk classes, national product codes.DeviceModel.classification(xsd)(doc)=
<#base:DeviceDefinition.classification>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A classification or risk class of the device model. Binding: device-type (example, Type of device e.g. according to official classification.); (xsd)type:CodeableConcept>
[]< Further information qualifying this classification of the device model.; (xsd)justification:RelatedArtifact>*🔗 Identifies the standards, specifications, or formal guidances for the capabilities supported by the device. The device may be certified as conformant to these specifications e.g., communication, performance, process, measurement, or specialization standards.DeviceModel.conformsTo(xsd)(doc)=
<#base:DeviceDefinition.conformsTo>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Describes the type of the standard, specification, or formal guidance. Binding: device-specification-category (example, ); (xsd)category:CodeableConcept>?
< Code that identifies the specific standard, specification, protocol, formal guidance, regulation, legislation, or certification scheme to which the device adheres. Binding: device-specification-type (example, ); (xsd)specification:CodeableConcept>
[]< Identifies the specific form or variant of the standard, specification, or formal guidance. This may be a 'version number', release, document edition, publication year, or other label.; (xsd)version:string>*
[]< Standard, regulation, certification, or guidance website, document, or other publication, or similar, supporting the conformance.; (xsd)source:RelatedArtifact>*🔗 Tracking of latest field safety corrective action.DeviceModel.correctiveAction(xsd)(doc)=
<#base:DeviceDefinition.correctiveAction>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Whether the last corrective action known for this device was a recall. When a field safety action has been initiated but not yet resulted in a recall, this element will be set to 'false'.; (xsd)recall:boolean>
< The scope of the corrective action - whether the action targeted all units of a given device model, or only a specific set of batches identified by lot numbers, or individually identified devices identified by the serial name. Binding: device-correctiveactionscope (required, The type or scope of the corrective action.); (xsd)scope:code>?
< Start and end dates of the corrective action.; (xsd)period:Period>🔗 The name or names of the device as given by the manufacturer.DeviceModel.deviceName(xsd)(doc)=
<#base:DeviceDefinition.deviceName>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A human-friendly name that is used to refer to the device - depending on the type, it can be the brand name, the common name or alias, or other.; (xsd)name:string>
< The type of deviceName.
RegisteredName | UserFriendlyName | PatientReportedName. Binding: device-nametype (required, The type of name the device is referred by.); (xsd)type:code>🔗 European Medical Device Nomenclature In this element various classifications can be used, such as GMDN, EMDN, SNOMED CT, risk classes, national product codes.DeviceModel.emdn(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A classification or risk class of the device model. Binding: device-type (example, Type of device e.g. according to official classification.); (xsd)type:DeviceModel.emdn.type>
[]< Further information qualifying this classification of the device model.; (xsd)justification:RelatedArtifact>*🔗 A classification or risk class of the device model. Binding: device-type (example, Type of device e.g. according to official classification.)DeviceModel.emdn.type(xsd)(doc)=
<#base:CodeableConcept>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< 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.; (xsd)coding:DeviceModel.emdn.type.coding>*
< 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.; (xsd)text:string>?🔗 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.DeviceModel.emdn.type.coding(xsd)(doc)=
<#base:Coding>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< 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 be an absolute reference to some definition that establishes the system clearly and unambiguously.; (xsd)system:uri>
< 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.; (xsd)version:string>?
< 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).; (xsd)code>?
< A representation of the meaning of the code in the system, following the rules of the system.; (xsd)display:string>?
< 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.; (xsd)userSelected:boolean>?🔗 Global Medical Device Nomenclature classification In this element various classifications can be used, such as GMDN, EMDN, SNOMED CT, risk classes, national product codes.DeviceModel.gmdn(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A classification or risk class of the device model. Binding: device-type (example, Type of device e.g. according to official classification.); (xsd)type:DeviceModel.gmdn.type>
[]< Further information qualifying this classification of the device model.; (xsd)justification:RelatedArtifact>*🔗 A classification or risk class of the device model. Binding: device-type (example, Type of device e.g. according to official classification.)DeviceModel.gmdn.type(xsd)(doc)=
<#base:CodeableConcept>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< 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.; (xsd)coding:DeviceModel.gmdn.type.coding>*
< 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.; (xsd)text:string>?🔗 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.DeviceModel.gmdn.type.coding(xsd)(doc)=
<#base:Coding>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< 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 be an absolute reference to some definition that establishes the system clearly and unambiguously.; (xsd)system:uri>
< 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.; (xsd)version:string>?
< 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).; (xsd)code>?
< A representation of the meaning of the code in the system, following the rules of the system.; (xsd)display:string>?
< 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.; (xsd)userSelected:boolean>?🔗 Information aimed at providing directions for the usage of this model of device. For more structured data, a ClinicalUseDefinition that points to the DeviceDefinition can be used.DeviceModel.guideline(xsd)(doc)=
<#base:DeviceDefinition.guideline>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< The circumstances that form the setting for using the device.; (xsd)useContext:UsageContext>*
< Detailed written and visual directions for the user on how to use the device.; (xsd)usageInstruction:markdown>?
[]< A source of information or reference for this guideline.; (xsd)relatedArtifact:RelatedArtifact>*
[]< A clinical condition for which the device was designed to be used. A ClinicalUseDefinition that points to the DeviceDefinition can be used if more structured data is needed.; (xsd)indication:CodeableConcept>*
[]< A specific situation when a device should not be used because it may cause harm. A ClinicalUseDefinition that points to the DeviceDefinition can be used if more structured data is needed.; (xsd)contraindication:CodeableConcept>*
[]< Specific hazard alert information that a user needs to know before using the device. A ClinicalUseDefinition that points to the DeviceDefinition can be used if more structured data is needed.; (xsd)warning:CodeableConcept>*
< A description of the general purpose or medical use of the device or its function.; (xsd)intendedUse:string>?🔗 A device that is part (for example a component) of the present device.DeviceModel.hasPart(xsd)(doc)=
<#base:DeviceDefinition.hasPart>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Reference to the device that is part of the current device.; (xsd)reference:DeviceDefinition*>
< Number of instances of the component device in the current device.; (xsd)count:integer>?🔗 Billing code or reference associated with the device.DeviceModel.chargeItem(xsd)(doc)=
<#base:DeviceDefinition.chargeItem>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The code or reference for the charge item.; (xsd)chargeItemCode:ChargeItemDefinition*>
< Coefficient applicable to the billing code.; (xsd)count:Quantity>
< A specific time period in which this charge item applies.; (xsd)effectivePeriod:Period>?
[]< The context to which this charge item applies.; (xsd)useContext:UsageContext>*🔗 An associated device, attached to, used with, communicating with or linking a previous or new device model to the focal device.DeviceModel.link(xsd)(doc)=
<#base:DeviceDefinition.link>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The type indicates the relationship of the related device to the device instance. Binding: devicedefinition-relationtype (extensible, The type of relation between this and the linked device.); (xsd)relation:Coding>
< A reference to the linked device.; (xsd)relatedDevice:DeviceDefinition*>🔗 A substance used to create the material(s) of which the device is made.DeviceModel.material(xsd)(doc)=
<#base:DeviceDefinition.material>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A substance that the device contains, may contain, or is made of - for example latex - to be used to determine patient compatibility. This is not intended to represent the composition of the device, only the clinically relevant materials.; (xsd)substance:CodeableConcept>
< Indicates an alternative material of the device.; (xsd)alternate:boolean>?
< Whether the substance is a known or suspected allergen.; (xsd)allergenicIndicator:boolean>?🔗 Information about the packaging of the device, i.e. how the device is packaged.DeviceModel.packaging(xsd)(doc)=
<#base:DeviceDefinition.packaging>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The business identifier of the packaged medication.; (xsd)identifier:Identifier>?
< A code that defines the specific type of packaging.; (xsd)type:CodeableConcept>?
< The number of items contained in the package (devices or sub-packages).; (xsd)count:integer>?
[]< An organization that distributes the packaged device.; (xsd)distributor:DeviceModel.packaging.distributor>*
[]< Unique Device Identifier (UDI) Barcode string on the packaging.; (xsd)udiDeviceIdentifier:DeviceModel.packaging.udiDeviceIdentifier>*
[]< Allows packages within packages.; (xsd)packaging:DeviceDefinition.packaging>*🔗 An organization that distributes the packaged device.DeviceModel.packaging.distributor(xsd)(doc)=
<#base:DeviceDefinition.packaging.distributor>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Distributor's human-readable name.; (xsd)name:string>?
[]< Distributor as an Organization resource.; (xsd)organizationReference:Organization*>*🔗 Unique Device Identifier (UDI) Barcode string on the packaging.DeviceModel.packaging.udiDeviceIdentifier(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The identifier that is to be associated with every Device that references this DeviceDefintiion for the issuer and jurisdiction provided in the DeviceDefinition.udiDeviceIdentifier.; (xsd)deviceIdentifier:string>
< Organization accredited by the jurisdictional authority to operate a system for the issuance of UDIs. Main issuers referenced in the US and/or in EU include:
1. GS1 GTIN: urn:oid:1.3.160,
2. HIBCC: urn:oid:2.16.840.1.113883.6.40,
3. ICCBBA Information Standard for Blood and Transplant (ISBT) 128: urn:oid:2.16.840.1.113883.6.18,
4. ICCBBA for other devices: to be found,
5. IFA (Europe Union only): to be found; (xsd)issuer:uri>
< The jurisdiction to which the deviceIdentifier applies.; (xsd)jurisdiction:uri>
[]< Indicates where and when the device is available on the market.; (xsd)marketDistribution:DeviceModel.packaging.udiDeviceIdentifier.marketDistribution>*🔗 Indicates where and when the device is available on the market.DeviceModel.packaging.udiDeviceIdentifier.marketDistribution(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Begin and end dates for the commercial distribution of the device.; (xsd)marketPeriod:DeviceModel.packaging.udiDeviceIdentifier.marketDistribution.marketPeriod>
< National state or territory to which the marketDistribution recers, typically where the device is commercialized.; (xsd)subJurisdiction:uri>🔗 Begin and end dates for the commercial distribution of the device.DeviceModel.packaging.udiDeviceIdentifier.marketDistribution.marketPeriod(xsd)(doc)=
<#base:Period>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< 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.; (xsd)start:dateTime>?
< The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. The end value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.; (xsd)end:dateTime>?🔗 Static or essentially fixed characteristics or features of this kind of device that are otherwise not captured in more specific attributes, e.g., time or timing attributes, resolution, accuracy, and physical attributes. Dynamic or current properties, such as settings, of an individual device are described using a Device instance-specific DeviceMetric and recorded using Observation. Static characteristics of an individual device could also be documented in a [Device] instance. The Device instance's properties, and their values, could be, but need not be, the same as in the associated DeviceDefinition.DeviceModel.property(xsd)(doc)=
<#base:DeviceDefinition.property>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Code that specifies the property such as a resolution or color being represented. Binding: device-property-type (example, Device property type.); (xsd)type:CodeableConcept>
(<valueAttachment:Attachment>
|<valueBoolean:boolean>
|<valueCodeableConcept:CodeableConcept>
|<valueInteger:integer>
|<valueQuantity:Quantity>
|<valueRange:Range>
|<valueString:string>)🔗 Identifier associated with the regulatory documentation (certificates, technical documentation, post-market surveillance documentation and reports) of a set of device models sharing the same intended purpose, risk class and essential design and manufacturing characteristics. One example is the Basic UDI-DI in Europe. This should not be used for regulatory authorization numbers which are to be captured elsewhere.DeviceModel.regulatoryIdentifier(xsd)(doc)=
<#base:DeviceDefinition.regulatoryIdentifier>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The type of identifier itself. Binding: devicedefinition-regulatory-identifier-type (required, Device regulatory identifier type.); (xsd)type:code>
< The identifier itself.; (xsd)deviceIdentifier:string>
< The organization that issued this identifier.; (xsd)issuer:uri>
< The jurisdiction to which the deviceIdentifier applies.; (xsd)jurisdiction:uri>🔗 Systematized nomenclature of medicine - clinical terms In this element various classifications can be used, such as GMDN, EMDN, SNOMED CT, risk classes, national product codes.DeviceModel.snomed(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A classification or risk class of the device model. Binding: device-type (example, Type of device e.g. according to official classification.); (xsd)type:DeviceModel.snomed.type>
[]< Further information qualifying this classification of the device model.; (xsd)justification:RelatedArtifact>*🔗 A classification or risk class of the device model. Binding: device-type (example, Type of device e.g. according to official classification.)DeviceModel.snomed.type(xsd)(doc)=
<#base:CodeableConcept>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< 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.; (xsd)coding:DeviceModel.snomed.type.coding>*
< 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.; (xsd)text:string>?🔗 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.DeviceModel.snomed.type.coding(xsd)(doc)=
<#base:Coding>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< 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 be an absolute reference to some definition that establishes the system clearly and unambiguously.; (xsd)system:uri>
< 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.; (xsd)version:string>?
< 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).; (xsd)code>?
< A representation of the meaning of the code in the system, following the rules of the system.; (xsd)display:string>?
< 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.; (xsd)userSelected:boolean>?🔗 Unique device identifier (UDI) assigned to device label or package. Note that the Device may include multiple udiCarriers as it either may include just the udiCarrier for the jurisdiction it is sold, or for multiple jurisdictions it could have been sold.DeviceModel.udiDeviceIdentifier(xsd)(doc)=
<#base:DeviceDefinition.udiDeviceIdentifier>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The identifier that is to be associated with every Device that references this DeviceDefintiion for the issuer and jurisdiction provided in the DeviceDefinition.udiDeviceIdentifier.; (xsd)deviceIdentifier:string>
< Organization accredited by the jurisdictional authority to operate a system for the issuance of UDIs. Main issuers referenced in the US and/or in EU include:
1. GS1 GTIN: urn:oid:1.3.160,
2. HIBCC: urn:oid:2.16.840.1.113883.6.40,
3. ICCBBA Information Standard for Blood and Transplant (ISBT) 128: urn:oid:2.16.840.1.113883.6.18,
4. ICCBBA for other devices: to be found,
5. IFA (Europe Union only): to be found; (xsd)issuer:uri>
< The jurisdiction to which the deviceIdentifier applies. Known jurisdictions are:
1. US Food & Drug Administration (FDA): urn:oid:2.16.840.1.113883.3.150,
2. Europe Union EUDAMED: https://ec.europa.eu/health/medical-devices-sector_en; (xsd)jurisdiction:uri>
[]< Indicates where and when the device is available on the market.; (xsd)marketDistribution:DeviceModel.udiDeviceIdentifier.marketDistribution>*🔗 Indicates where and when the device is available on the market.DeviceModel.udiDeviceIdentifier.marketDistribution(xsd)(doc)=
<#base:DeviceDefinition.udiDeviceIdentifier.marketDistribution>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Begin and end dates for the commercial distribution of the device.; (xsd)marketPeriod:DeviceModel.udiDeviceIdentifier.marketDistribution.marketPeriod>
< National state or territory to which the marketDistribution recers, typically where the device is commercialized.; (xsd)subJurisdiction:uri>🔗 Begin and end dates for the commercial distribution of the device.DeviceModel.udiDeviceIdentifier.marketDistribution.marketPeriod(xsd)(doc)=
<#base:Period>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< 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.; (xsd)start:dateTime>?
< The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. The end value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.; (xsd)end:dateTime>?🔗 The version of the device or software.DeviceModel.version(xsd)(doc)=
<#base:DeviceDefinition.version>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The type of the device version, e.g. manufacturer, approved, internal.; (xsd)type:CodeableConcept>?
< The hardware or software module of the device to which the version applies. Note that the module of the device would not need to be tracked as a separate device, e.g., using different UDI, thus would typically involve one or more software modules. For example, a device may involve two software modules each on a different version.; (xsd)component:Identifier>?
< The version text.; (xsd)value:string>🔗 Represents a request for a patient to employ a medical device. The device may be an implantable device, or an external assistive device, such as a walker.DeviceRequest(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< Identifiers assigned to this order by the orderer or by the receiver.; (xsd)identifier:Identifier>*
[]< The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this DeviceRequest. Note: This is a business identifier, not a resource identifier (see [discussion](resource.html#identifiers)). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.; (xsd)instantiatesCanonical:(<ActivityDefinition>
|<PlanDefinition>)>*
[]< The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this DeviceRequest. This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.; (xsd)instantiatesUri:uri>*
[]< Plan/proposal/order fulfilled by this request.; (xsd)basedOn:Resource*>*
[]< The request takes the place of the referenced completed or terminated request(s).; (xsd)replaces:DeviceRequest*>*
< A shared identifier common to multiple independent Request instances that were activated/authorized more or less simultaneously by a single author. The presence of the same identifier on each request ties those requests together and may have business ramifications in terms of reporting of results, billing, etc. E.g. a requisition number shared by a set of lab tests ordered together, or a prescription number shared by all meds ordered at one time.; (xsd)groupIdentifier:Identifier>?
< The status of the request. This element is labeled as a modifier because the status contains the codes revoked and entered-in-error that mark the request as not currently valid. Binding: request-status (required, Codes representing the status of the request.); (xsd)status:code>?
< Whether the request is a proposal, plan, an original order or a reflex order. Binding: request-intent (required, The kind of diagnostic request.); (xsd)intent:code>
< Indicates how quickly the request should be addressed with respect to other requests. Binding: request-priority (required, Identifies the level of importance to be assigned to actioning the request.); (xsd)priority:code>?
< If true, indicates that the provider is asking for the patient to either stop using or to not start using the specified device or category of devices. For example, the patient has undergone surgery and the provider is indicating that the patient should not wear contact lenses. If do not perform is not specified, the request is a positive request e.g. "do perform". DeviceRequest.reasonCode includes the reason for marking the DeviceRequest as 'do not perform'.; (xsd)doNotPerform:boolean>?
< The details of the device to be used. Binding: device-type (example, Codes for devices that can be requested.); (xsd)code:(<Device>
|<DeviceDefinition>)>
< The number of devices to be provided.; (xsd)quantity:integer>?
[]< Specific parameters for the ordered item. For example, the prism value for lenses.; (xsd)parameter:DeviceRequest.parameter>*
< The patient who will use the device.; (xsd)subject:(<Device>
|<Group>
|<Location>
|<Patient>)>
< An encounter that provides additional context in which this request is made.; (xsd)encounter:Encounter*>?
< The timing schedule for the use of the device. The Schedule data type allows many different expressions, for example. "Every 8 hours"; "Three times a day"; "1/2 an hour before breakfast for 10 days from 23-Dec 2011:"; "15 Oct 2013, 17 Oct 2013 and 1 Nov 2013".; (xsd)occurrence:(<dateTime>
|<Period>
|<Timing>)>?
< When the request transitioned to being actionable.; (xsd)authoredOn:dateTime>?
< The individual or entity who initiated the request and has responsibility for its activation.; (xsd)requester:(<Device>
|<Organization>
|<Practitioner>
|<PractitionerRole>)>?
< The desired individual or entity to provide the device to the subject of the request (e.g., patient, location).; (xsd)performer:(<CareTeam>
|<Device>
|<HealthcareService>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>?
[]< Reason or justification for the use of this device. Binding: condition-code (example, Diagnosis or problem codes justifying the reason for requesting the device.); (xsd)reason:(<Condition>
|<DiagnosticReport>
|<DocumentReference>
|<Observation>)>*
< This status is to indicate whether the request is a PRN or may be given as needed.; (xsd)asNeeded:boolean>?
< The reason for using the device.; (xsd)asNeededFor:CodeableConcept>?
[]< Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be required for delivering the requested service.; (xsd)insurance:(<ClaimResponse>
|<Coverage>)>*
[]< Additional clinical information about the patient that may influence the request fulfilment. For example, this may include where on the subject's body the device will be used (i.e. the target site).; (xsd)supportingInfo:Resource*>*
[]< Details about this request that were not represented at all or sufficiently in one of the attributes provided in a class. These may include for example a comment, an instruction, or a note associated with the statement.; (xsd)note:Annotation>*
[]< Key events in the history of the request. This might not include provenances for all versions of the request - only those deemed "relevant" or important.
This SHALL NOT include the Provenance associated with this current version of the resource. (If that provenance is deemed to be a "relevant" change, it will need to be added as part of a later update. Until then, it can be queried directly as the Provenance that points to this version using _revinclude
All Provenances should have some historical version of this Request as their subject.; (xsd)relevantHistory:Provenance*>*🔗 Specific parameters for the ordered item. For example, the prism value for lenses.DeviceRequest.parameter(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A code or string that identifies the device detail being asserted. Binding: (example, A code that identifies the device detail.); (xsd)code:CodeableConcept>?
(<valueBoolean:boolean>
|<valueCodeableConcept:CodeableConcept>
|<valueQuantity:Quantity>
|<valueRange:Range>)?🔗 A record of a device being used by a patient where the record is the result of a report from the patient or a clinician.DeviceUsage(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< An external identifier for this statement such as an IRI.; (xsd)identifier:Identifier>*
[]< A plan, proposal or order that is fulfilled in whole or in part by this DeviceUsage.; (xsd)basedOn:ServiceRequest*>*
< A code representing the patient or other source's judgment about the state of the device used that this statement is about. Generally this will be active or completed. DeviceUseStatment is a statement at a point in time. The status is only representative at the point when it was asserted. The value set for contains codes that assert the status of the use by the patient (for example, stopped or on hold) as well as codes that assert the status of the resource itself (for example, entered in error).
This element is labeled as a modifier because the status contains the codes that mark the statement as not currently valid. Binding: deviceusage-status (required, A coded concept indicating the current status of the Device Usage.); (xsd)status:code>
[]< This attribute indicates a category for the statement - The device statement may be made in an inpatient or outpatient settting (inpatient | outpatient | community | patientspecified).; (xsd)category:CodeableConcept>*
< The patient who used the device.; (xsd)patient:Patient*>
[]< Allows linking the DeviceUsage to the underlying Request, or to other information that supports or is used to derive the DeviceUsage. The most common use cases for deriving a DeviceUsage comes from creating it from a request or from an observation or a claim. it should be noted that the amount of information that is available varies from the type resource that you derive the DeviceUsage from.; (xsd)derivedFrom:(<Claim>
|<DocumentReference>
|<Observation>
|<Procedure>
|<QuestionnaireResponse>
|<ServiceRequest>)>*
< The encounter or episode of care that establishes the context for this device use statement.; (xsd)context:(<Encounter>
|<EpisodeOfCare>)>?
< How often the device was used.; (xsd)timing:(<dateTime>
|<Period>
|<Timing>)>?
< The time at which the statement was recorded by informationSource.; (xsd)dateAsserted:dateTime>?
< The status of the device usage, for example always, sometimes, never. This is not the same as the status of the statement. Binding: deviceusage-status (required, Codes representing the usage status of the device.); (xsd)usageStatus:CodeableConcept>?
[]< The reason for asserting the usage status - for example forgot, lost, stolen, broken.; (xsd)usageReason:CodeableConcept>*
< This indicates how or if the device is being used.; (xsd)adherence:DeviceUsage.adherence>?
< Who reported the device was being used by the patient.; (xsd)informationSource:(<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>?
< Code or Reference to device used.; (xsd)device:(<Device>
|<DeviceDefinition>)>
[]< Reason or justification for the use of the device. A coded concept, or another resource whose existence justifies this DeviceUsage. When the status is not done, the reason code indicates why it was not done.; (xsd)reason:(<Condition>
|<DiagnosticReport>
|<DocumentReference>
|<Observation>
|<Procedure>)>*
< Indicates the anotomic location on the subject's body where the device was used ( i.e. the target). Binding: body-site (example, SNOMED CT Body site concepts); (xsd)bodySite:BodyStructure*>?
[]< Details about the device statement that were not represented at all or sufficiently in one of the attributes provided in a class. These may include for example a comment, an instruction, or a note associated with the statement.; (xsd)note:Annotation>*🔗 This indicates how or if the device is being used.DeviceUsage.adherence(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Type of adherence. Binding: deviceusage-adherence-code (example, Codes for adherence); (xsd)code:CodeableConcept>
[]< Reason for adherence type. Binding: deviceusage-adherence-reason (example, Codes for adherence reason); (xsd)reason:CodeableConcept>+🔗 The findings and interpretation of diagnostic tests performed on patients, groups of patients, products, substances, devices, and locations, and/or specimens derived from these. The report includes clinical context such as requesting provider information, and some mix of atomic results, images, textual and coded interpretations, and formatted representation of diagnostic reports. The report also includes non-clinical context such as batch analysis and stability reporting of products and substances. This is intended to capture a single report and is not suitable for use in displaying summary information that covers multiple reports. For example, this resource has not been designed for laboratory cumulative reporting formats nor detailed structured reports for sequencing.DiagnosticReport(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< Identifiers assigned to this report by the performer or other systems. Usually assigned by the Information System of the diagnostic service provider (filler id).; (xsd)identifier:Identifier>*
[]< Details concerning a service requested. Note: Usually there is one test request for each result, however in some circumstances multiple test requests may be represented using a single test result resource. Note that there are also cases where one request leads to multiple reports.; (xsd)basedOn:(<CarePlan>
|<ImmunizationRecommendation>
|<MedicationRequest>
|<NutritionOrder>
|<ServiceRequest>)>*
< The status of the diagnostic report. Binding: diagnostic-report-status (required, The status of the diagnostic report.); (xsd)status:code>
[]< A code that classifies the clinical discipline, department or diagnostic service that created the report (e.g. cardiology, biochemistry, hematology, MRI). This is used for searching, sorting and display purposes. Multiple categories are allowed using various categorization schemes. The level of granularity is defined by the category concepts in the value set. More fine-grained filtering can be performed using the metadata and/or terminology hierarchy in DiagnosticReport.code. Binding: diagnostic-service-sections (example, HL7 V2 table 0074); (xsd)category:CodeableConcept>*
< A code or name that describes this diagnostic report. Binding: report-codes (preferred, LOINC Codes for Diagnostic Reports); (xsd)code:CodeableConcept>
< The subject of the report. Usually, but not always, this is a patient. However, diagnostic services also perform analyses on specimens collected from a variety of other sources.; (xsd)subject:(<BiologicallyDerivedProduct>
|<Device>
|<Group>
|<Location>
|<Medication>
|<Organization>
|<Patient>
|<Practitioner>
|<Substance>)>?
< The healthcare event (e.g. a patient and healthcare provider interaction) which this DiagnosticReport is about. This will typically be the encounter the event occurred within, but some events may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission laboratory tests).; (xsd)encounter:Encounter*>?
< The time or time-period the observed values are related to. When the subject of the report is a patient, this is usually either the time of the procedure or of specimen collection(s), but very often the source of the date/time is not known, only the date/time itself. If the diagnostic procedure was performed on the patient, this is the time it was performed. If there are specimens, the diagnostically relevant time can be derived from the specimen collection times, but the specimen information is not always available, and the exact relationship between the specimens and the diagnostically relevant time is not always automatic.; (xsd)effective:(<dateTime>
|<Period>)>?
< The date and time that this version of the report was made available to providers, typically after the report was reviewed and verified. May be different from the update time of the resource itself, because that is the status of the record (potentially a secondary copy), not the actual release time of the report.; (xsd)issued:instant>?
[]< The diagnostic service that is responsible for issuing the report. This is not necessarily the source of the atomic data items or the entity that interpreted the results. It is the entity that takes responsibility for the clinical report.; (xsd)performer:(<CareTeam>
|<Organization>
|<Practitioner>
|<PractitionerRole>)>*
[]< The practitioner or organization that is responsible for the report's conclusions and interpretations. Might not be the same entity that takes responsibility for the clinical report.; (xsd)resultsInterpreter:(<CareTeam>
|<Organization>
|<Practitioner>
|<PractitionerRole>)>*
[]< Details about the specimens on which this diagnostic report is based. If the specimen is sufficiently specified with a code in the test result name, then this additional data may be redundant. If there are multiple specimens, these may be represented per observation or group.; (xsd)specimen:Specimen*>*
[]< [Observations](observation.html) that are part of this diagnostic report. Observations can contain observations.; (xsd)result:Observation*>*
[]< Comments about the diagnostic report. May include general statements about the diagnostic report, or statements about significant, unexpected or unreliable results values contained within the diagnostic report, or information about its source when relevant to its interpretation.; (xsd)note:Annotation>*
[]< One or more links to full details of any study performed during the diagnostic investigation. An ImagingStudy might comprise a set of radiologic images obtained via a procedure that are analyzed as a group. Typically, this is imaging performed by DICOM enabled modalities, but this is not required. A fully enabled PACS viewer can use this information to provide views of the source images. A GenomicStudy might comprise one or more analyses, each serving a specific purpose. These analyses may vary in method (e.g., karyotyping, CNV, or SNV detection), performer, software, devices used, or regions targeted. For laboratory-type studies like GenomeStudy, type resources will be used for tracking additional metadata and workflow aspects of complex studies. ImagingStudy and the media element are somewhat overlapping - typically, the list of image references in the media element will also be found in one of the imaging study resources. However, each caters to different types of displays for different types of purposes. Neither, either, or both may be provided.; (xsd)study:(<GenomicStudy>
|<ImagingStudy>)>*
[]< This backbone element contains supporting information that was used in the creation of the report not included in the results already included in the report.; (xsd)supportingInfo:DiagnosticReport.supportingInfo>*
[]< A list of key images or data associated with this report. The images or data are generally created during the diagnostic process, and may be directly of the patient, or of treated specimens (i.e. slides of interest).; (xsd)media:DiagnosticReport.media>*
< Reference to a Composition resource instance that provides structure for organizing the contents of the DiagnosticReport. The Composition provides structure to the content of the DiagnosticReport (and only contains contents referenced in the DiagnosticReport) - e.g., to order the sections of an anatomic pathology structured report.; (xsd)composition:Composition*>?
< Concise and clinically contextualized summary conclusion (interpretation/impression) of the diagnostic report.; (xsd)conclusion:markdown>?
[]< One or more codes that represent the summary conclusion (interpretation/impression) of the diagnostic report. Binding: clinical-findings (example, SNOMED CT Clinical Findings); (xsd)conclusionCode:CodeableConcept>*
[]< Rich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they SHALL be semantically equivalent. "application/pdf" is recommended as the most reliable and interoperable in this context.; (xsd)presentedForm:Attachment>*🔗 A list of key images or data associated with this report. The images or data are generally created during the diagnostic process, and may be directly of the patient, or of treated specimens (i.e. slides of interest).DiagnosticReport.media(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A comment about the image or data. Typically, this is used to provide an explanation for why the image or data is included, or to draw the viewer's attention to important features. The comment should be displayed with the image or data. It would be common for the report to include additional discussion of the image or data contents or in other sections such as the conclusion.; (xsd)comment:string>?
< Reference to the image or data source.; (xsd)link:DocumentReference*>🔗 This backbone element contains supporting information that was used in the creation of the report not included in the results already included in the report.DiagnosticReport.supportingInfo(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The code value for the role of the supporting information in the diagnostic report. Binding: http://terminology.hl7.org/ValueSet/v2-0936 (example, The code value for the role of the supporting information in the diagnostic report.); (xsd)type:CodeableConcept>
< The reference for the supporting information in the diagnostic report.; (xsd)reference:(<Citation>
|<DiagnosticReport>
|<Observation>
|<Procedure>)>🔗 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. Binding: distance-units (extensible, Appropriate units for Distance.)Distance(xsd)(doc)=
<#base:Quantity>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< 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).; (xsd)value:decimal>?
< 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. Binding: quantity-comparator (required, How the Quantity should be understood and represented.); (xsd)comparator:code>?
< A human-readable form of the unit.; (xsd)unit:string>?
< The identification of the system that provides the coded form of the unit.; (xsd)system:uri>?
< 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.; (xsd)code>?🔗 A container the resources of a FHIR document.document-bundle(xsd)(doc)=
<#base:Bundle>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< A persistent identifier for the bundle that won't change as a bundle is copied from server to server. Persistent identity generally only matters for batches of type Document, Message, and Collection. It would not normally be populated for search and history results and servers ignore Bundle.identifier when processing batches and transactions. For Documents the .identifier SHALL be populated such that the .identifier is globally unique.; (xsd)identifier:document-bundle.identifier>
< Indicates the purpose of this bundle - how it is intended to be used. It's possible to use a bundle for other purposes (e.g. a document can be accepted as a transaction). This is primarily defined so that there can be specific rules for some of the bundle types. Binding: bundle-type (required, Indicates the purpose of a bundle - how it is intended to be used.) document; (xsd)type:code>
< The date/time that the bundle was assembled - i.e. when the resources were placed in the bundle. For many bundles, the timestamp is equal to .meta.lastUpdated, because they are not stored (e.g. search results). When a bundle is placed in a persistent store, .meta.lastUpdated will be usually be changed by the server. When the bundle is a message, a middleware agent altering the message (even if not stored) SHOULD update .meta.lastUpdated. .timestamp is used to track the original time of the Bundle, and SHOULD be populated.
Usage:
* document : the date the document was created. Note: the composition may predate the document, or be associated with multiple documents. The date of the composition - the authoring time - may be earlier than the document assembly time
* message : the date that the content of the message was assembled. This date is not changed by middleware engines unless they add additional data that changes the meaning of the time of the message
* history : the date that the history was assembled. This time would be used as the _since time to ask for subsequent updates
* searchset : the time that the search set was assembled. Note that different pages MAY have different timestamps but need not. Having different timestamps does not imply that subsequent pages will represent or include changes made since the initial query
* transaction | transaction-response | batch | batch-response | collection : no particular assigned meaning
The timestamp value should be greater than the lastUpdated and other timestamps in the resources in the bundle, and it should be equal or earlier than the .meta.lastUpdated on the Bundle itself.; (xsd)timestamp:instant>
< If a set of search matches, this is the (potentially estimated) total number of entries of type 'match' across all pages in the search. It does not include search.mode = 'include' or 'outcome' entries and it does not provide a count of the number of entries in the Bundle. Only used if the bundle is a search result set. The total does not include resources such as OperationOutcome and included resources, only the total number of matching resources.; (xsd)total:unsignedInt>{0,0}
[]< A series of links that provide context to this bundle. Both Bundle.link and Bundle.entry.link are defined to support providing additional context when Bundles are used (e.g. [HATEOAS](http://en.wikipedia.org/wiki/HATEOAS)).
Bundle.entry.link corresponds to links found in the HTTP header if the resource in the entry was [read](http.html#read) directly.
This specification defines some specific uses of Bundle.link for [searching](search.html#conformance) and [paging](http.html#paging), but no specific uses for Bundle.entry.link, and no defined function in a transaction - the meaning is implementation specific. The behavior of navigation link types (next/prev/first/last) are well defined for searchset and history Bundles but are not currently defined for other types. Implementers who choose to use such link relationships for other bundle types will need to negotiate behavior with their interoperability partners.; (xsd)link:document-bundle.link>*
[]< An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).; (xsd)entry:document-bundle.entry>+
< Digital Signature - base64 encoded. XML-DSig or a JWS. The signature could be created by the "author" of the bundle or by the originating device. Requirements around inclusion of a signature, verification of signatures and treatment of signed/non-signed bundles is implementation-environment specific.; (xsd)signature:Signature>?
< Captures issues and warnings that relate to the construction of the Bundle and the content within it. Usage notes: These issues and warnings must apply to the Bundle as a whole, not to individual entries.Messages relating to the processing of individual entries (e.g. in a batch or transaction) SHALL be reported in the entry.response.outcome for that entry. If there are errors that arise in the creation of the Bundle, then that should be handled by an OperationOutcome being returned instead of the Bundle.; (xsd)issues:OperationOutcome>{0,0}🔗 An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).document-bundle.entry(xsd)(doc)=
<#base:Bundle.entry>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< A series of links that provide context to this entry.; (xsd)link:Bundle.link>*
< The Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when:
* invoking a create
* invoking or responding to an operation where the body is not a single identified resource
* invoking or returning the results of a search or history operation. fullUrl might not be [unique in the context of a resource](bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](references.html), the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the [regex](references.html#regex), then the 'id' portion of the fullUrl SHALL end with the Resource.id.
Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).; (xsd)fullUrl:uri>
< The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. This is allowed to be a Parameters resource if and only if it is referenced by something else within the Bundle that provides context/meaning.; (xsd)resource:Resource>
< Information about the search process that lead to the creation of this entry.; (xsd)search:document-bundle.entry.search>{0,0}
< Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.; (xsd)request:document-bundle.entry.request>{0,0}
< Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.; (xsd)response:document-bundle.entry.response>{0,0}🔗 Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.document-bundle.entry.request(xsd)(doc)=
<#base:Bundle.entry.request>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred. Binding: http-verb (required, HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details.); (xsd)method:code>
< The URL for this entry, relative to the root (the address to which the request is posted). E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]".; (xsd)url:uri>
< If the ETag values match, return a 304 Not Modified status. See the API documentation for ["Conditional Read"](http.html#cread).; (xsd)ifNoneMatch:string>?
< Only perform the operation if the last updated date matches. See the API documentation for ["Conditional Read"](http.html#cread).; (xsd)ifModifiedSince:instant>?
< Only perform the operation if the Etag value matches. For more information, see the API section ["Managing Resource Contention"](http.html#concurrency).; (xsd)ifMatch:string>?
< Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for ["Conditional Create"](http.html#ccreate). This is just the query portion of the URL - what follows the "?" (not including the "?").; (xsd)ifNoneExist:string>?🔗 Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.document-bundle.entry.response(xsd)(doc)=
<#base:Bundle.entry.response>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.; (xsd)status:string>
< The location header created by processing this operation, populated if the operation returns a location.; (xsd)location:uri>?
< The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)). Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.; (xsd)etag:string>?
< The date/time that the resource was modified on the server. This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.; (xsd)lastModified:instant>?
< An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction. For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.
This outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.; (xsd)outcome:Resource>?🔗 Information about the search process that lead to the creation of this entry.document-bundle.entry.search(xsd)(doc)=
<#base:Bundle.entry.search>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence. Binding: search-entry-mode (required, Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.); (xsd)mode:code>?
< When searching, the server's search ranking score for the entry. Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.
See [Patient Match](patient-operation-match.html) for the EMPI search which relates to this element.; (xsd)score:decimal>?🔗 A persistent identifier for the bundle that won't change as a bundle is copied from server to server. Persistent identity generally only matters for batches of type Document, Message, and Collection. It would not normally be populated for search and history results and servers ignore Bundle.identifier when processing batches and transactions. For Documents the .identifier SHALL be populated such that the .identifier is globally unique.document-bundle.identifier(xsd)(doc)=
<#base:Identifier>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< The purpose of this identifier. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Binding: identifier-use (required, Identifies the purpose for this identifier, if known .); (xsd)use:code>?
< 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. Binding: identifier-type (extensible, A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.); (xsd)type:CodeableConcept>?
< Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique. Identifier.system is always case sensitive.; (xsd)system:uri>
< The portion of the identifier typically relevant to the user and which is unique within the context of the system. If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [http://hl7.org/fhir/StructureDefinition/rendered-value](http://hl7.org/fhir/extensions/StructureDefinition-rendered-value.html)). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.; (xsd)value:string>
< Time period during which identifier is/was valid for use.; (xsd)period:Period>?
< 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.; (xsd)assigner:Organization*>?🔗 A series of links that provide context to this bundle. Both Bundle.link and Bundle.entry.link are defined to support providing additional context when Bundles are used (e.g. [HATEOAS](http://en.wikipedia.org/wiki/HATEOAS)).
Bundle.entry.link corresponds to links found in the HTTP header if the resource in the entry was [read](http.html#read) directly.
This specification defines some specific uses of Bundle.link for [searching](search.html#conformance) and [paging](http.html#paging), but no specific uses for Bundle.entry.link, and no defined function in a transaction - the meaning is implementation specific. The behavior of navigation link types (next/prev/first/last) are well defined for searchset and history Bundles but are not currently defined for other types. Implementers who choose to use such link relationships for other bundle types will need to negotiate behavior with their interoperability partners.document-bundle.link(xsd)(doc)=
<#base:Bundle.link>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A name which details the functional use for this link - see [http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1](http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1). Binding: iana-link-relations (required, ); (xsd)relation:code>
< The reference details for the link.; (xsd)url:uri>🔗 A reference to a document of any kind for any purpose. While the term “document” implies a more narrow focus, for this resource this "document" encompasses *any* serialized object with a mime-type, it includes formal patient-centric documents (CDA), clinical notes, scanned paper, non-patient specific documents like policy text, as well as a photo, video, or audio recording acquired or used in healthcare. The DocumentReference resource provides metadata about the document so that the document can be discovered and managed. The actual content may be inline base64 encoded data or provided by direct reference. Usually, this is used for documents other than those defined by FHIR.DocumentReference(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< Other business identifiers associated with the document, including version independent identifiers. The structure and format of this identifier would be consistent with the specification corresponding to the format of the document. (e.g. for a DICOM standard document, a 64-character numeric UID; for an HL7 CDA format, the CDA Document Id root and extension).; (xsd)identifier:Identifier>*
< An explicitly assigned identifer of a variation of the content in the DocumentReference. While each resource, including the DocumentReference itself, has its own version identifier, this is a formal identifier for the logical version of the DocumentReference as a whole. It would remain constant if the resources were moved to a new server, and all got new individual resource versions, for example.; (xsd)version:string>?
[]< A procedure that is fulfilled in whole or in part by the creation of this media.; (xsd)basedOn:(<Appointment>
|<AppointmentResponse>
|<CarePlan>
|<Claim>
|<CommunicationRequest>
|<Contract>
|<CoverageEligibilityRequest>
|<DeviceRequest>
|<EnrollmentRequest>
|<ImmunizationRecommendation>
|<MedicationRequest>
|<NutritionOrder>
|<RequestOrchestration>
|<ServiceRequest>
|<SupplyRequest>
|<VisionPrescription>)>*
< The status of this document reference. This is the status of the DocumentReference object, which might be independent from the docStatus element.
This element is labeled as a modifier because the status contains the codes that mark the document or reference as not currently valid. Binding: document-reference-status (required, The status of the document reference.); (xsd)status:code>
< The status of the underlying document. The document that is pointed to might be in various lifecycle states. Binding: composition-status (required, Status of the underlying document.); (xsd)docStatus:code>?
[]< Imaging modality used. This may include both acquisition and non-acquisition modalities. Binding: http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_33.html (extensible, Type of acquired data in the instance.); (xsd)modality:CodeableConcept>*
< Specifies the particular kind of document referenced (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the document referenced. Key metadata element describing the document that describes he exact type of document. Helps humans to assess whether the document is of interest when viewing a list of documents. Binding: doc-typecodes (preferred, Precise type of clinical document.); (xsd)type:CodeableConcept>?
[]< A categorization for the type of document referenced - helps for indexing and searching. This may be implied by or derived from the code specified in the DocumentReference.type. Key metadata element describing the the category or classification of the document. This is a broader perspective that groups similar documents based on how they would be used. This is a primary key used in searching. Binding: referenced-item-category (example, High-level kind of document at a macro level.); (xsd)category:CodeableConcept>*
< Who or what the document is about. The document can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure).; (xsd)subject:Resource*>?
[]< Describes the clinical encounter or type of care that the document content is associated with.; (xsd)context:(<Appointment>
|<Encounter>
|<EpisodeOfCare>)>*
[]< This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the type Code, such as a "History and Physical Report" in which the procedure being documented is necessarily a "History and Physical" act. An event can further specialize the act inherent in the type, such as where it is simply "Procedure Report" and the procedure was a "colonoscopy". If one or more event codes are included, they shall not conflict with the values inherent in the class or type elements as such a conflict would create an ambiguous situation. Binding: http://terminology.hl7.org/ValueSet/v3-ActCode (example, This list of codes represents the main clinical acts being documented.); (xsd)event:Resource*>*
[]< The anatomic structures included in the document. Binding: body-site (example, SNOMED CT Body site concepts); (xsd)bodySite:BodyStructure*>*
< The kind of facility where the patient was seen. Binding: c80-facilitycodes (example, XDS Facility Type.); (xsd)facilityType:CodeableConcept>?
< This property may convey specifics about the practice setting where the content was created, often reflecting the clinical specialty. This element should be based on a coarse classification system for the class of specialty practice. Recommend the use of the classification system for Practice Setting, such as that described by the Subject Matter Domain in LOINC. Binding: c80-practice-codes (example, Additional details about where the content was created (e.g. clinical specialty).); (xsd)practiceSetting:CodeableConcept>?
< The time period over which the service that is described by the document was provided.; (xsd)period:Period>?
< When the document reference was created. Referencing/indexing time is used for tracking, organizing versions and searching.; (xsd)date:instant>?
[]< Identifies who is responsible for adding the information to the document. Not necessarily who did the actual data entry (i.e. typist) or who was the source (informant).; (xsd)author:(<CareTeam>
|<Device>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>*
[]< A participant who has authenticated the accuracy of the document. Only list each attester once.; (xsd)attester:DocumentReference.attester>*
< Identifies the organization or group who is responsible for ongoing maintenance of and access to the document. Identifies the logical organization (software system, vendor, or department) to go to find the current version, where to report issues, etc. This is different from the physical location (URL, disk drive, or server) of the document, which is the technical location of the document, which host may be delegated to the management of some other organization.; (xsd)custodian:Organization*>?
[]< Relationships that this document has with other document references that already exist. This element is labeled as a modifier because documents that append to other documents are incomplete on their own.; (xsd)relatesTo:DocumentReference.relatesTo>*
< Human-readable description of the source document. What the document is about, a terse summary of the document.; (xsd)description:markdown>?
[]< A set of Security-Tag codes specifying the level of privacy/security of the Document found at DocumentReference.content.attachment.url. Note that DocumentReference.meta.security contains the security labels of the data elements in DocumentReference, while DocumentReference.securityLabel contains the security labels for the document the reference refers to. The distinction recognizes that the document may contain sensitive information, while the DocumentReference is metadata about the document and thus might not be as sensitive as the document. For example: a psychotherapy episode may contain highly sensitive information, while the metadata may simply indicate that some episode happened. The confidentiality codes can carry multiple vocabulary items. HL7 has developed an understanding of security and privacy tags that might be desirable in a Document Sharing environment, called HL7 Healthcare Privacy and Security Classification System (HCS). The following specification is recommended but not mandated, as the vocabulary bindings are an administrative domain responsibility. The use of this method is up to the policy domain such as the XDS Affinity Domain or other Trust Domain where all parties including sender and recipients are trusted to appropriately tag and enforce.
In the HL7 Healthcare Privacy and Security Classification (HCS) there are code systems specific to Confidentiality, Sensitivity, Integrity, and Handling Caveats. Some values would come from a local vocabulary as they are related to workflow roles and special projects. Binding: security-label-examples (example, Example Security Labels from the Healthcare Privacy and Security Classification System.); (xsd)securityLabel:CodeableConcept>*
[]< The document and format referenced. If there are multiple content element repetitions, these must all represent the same document in different format, or attachment metadata. content element shall not contain different versions of the same content. For version handling use multiple DocumentReference with .relatesTo.; (xsd)content:DocumentReference.content>+🔗 A participant who has authenticated the accuracy of the document. Only list each attester once.DocumentReference.attester(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The type of attestation the authenticator offers. Binding: composition-attestation-mode (preferred, The way in which a person authenticated a document.); (xsd)mode:CodeableConcept>
< When the document was attested by the party.; (xsd)time:dateTime>?
< Who attested the document in the specified way.; (xsd)party:(<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>?🔗 The document and format referenced. If there are multiple content element repetitions, these must all represent the same document in different format, or attachment metadata. content element shall not contain different versions of the same content. For version handling use multiple DocumentReference with .relatesTo.DocumentReference.content(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The document or URL of the document along with critical metadata to prove content has integrity.; (xsd)attachment:Attachment>
[]< An identifier of the document constraints, encoding, structure, and template that the document conforms to beyond the base format indicated in the mimeType. Note that IHE often issues URNs for formatCode codes, not all documents can be identified by a URI.
For FHIR content, .profile should indicate the structureDefinition profile canonical URI(s) that the content complies with.; (xsd)profile:DocumentReference.content.profile>*🔗 An identifier of the document constraints, encoding, structure, and template that the document conforms to beyond the base format indicated in the mimeType. Note that IHE often issues URNs for formatCode codes, not all documents can be identified by a URI.
For FHIR content, .profile should indicate the structureDefinition profile canonical URI(s) that the content complies with.DocumentReference.content.profile(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
(<valueCoding:Coding>
|<valueResource:Resource>
|<valueUri:uri>)🔗 Relationships that this document has with other document references that already exist. This element is labeled as a modifier because documents that append to other documents are incomplete on their own.DocumentReference.relatesTo(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The type of relationship that this document has with anther document. If this document appends another document, then the document cannot be fully understood without also accessing the referenced document. Binding: document-relationship-type (extensible, The type of relationship between the documents.); (xsd)code:CodeableConcept>
< The target document of this relationship.; (xsd)target:DocumentReference*>🔗 A resource that includes narrative, extensions, and contained resources.DomainResource(xsd)(doc)=
<#base:Resource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*🔗 Indicates how the medication is/was taken or should be taken by the patient.Dosage(xsd)(doc)=
<#base:BackboneType>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Indicates the order in which the dosage instructions should be applied or interpreted.; (xsd)sequence:integer>?
< Free text dosage instructions e.g. SIG.; (xsd)text:string>?
[]< 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 take "immediately following drug x") should be populated in dosage.text. Binding: additional-instruction-codes (example, A coded concept identifying additional instructions such as "take with water" or "avoid operating heavy machinery".); (xsd)additionalInstruction:CodeableConcept>*
< Instructions in terms that are understood by the patient or consumer.; (xsd)patientInstruction:string>?
< 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.; (xsd)timing:Timing>?
< Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option). Can express "as needed" without a reason by setting the Boolean = True. In this case the CodeableConcept is not populated.; (xsd)asNeeded:boolean>?
[]< Indicates whether the Medication is only taken based on a precondition for taking the Medication (CodeableConcept). Can express "as needed" with a reason by including the CodeableConcept. In this case the Boolean is assumed to be False, then the dose is given according to the schedule and is not "prn" or "as needed". Binding: medication-as-needed-reason (example, A coded concept identifying the precondition that should be met or evaluated prior to consuming or administering a medication dose. For example "pain", "30 minutes prior to sexual intercourse", "on flare-up" etc.); (xsd)asNeededFor:CodeableConcept>*
< 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 [http://hl7.org/fhir/StructureDefinition/bodySite](http://hl7.org/fhir/extensions/StructureDefinition-bodySite.html). May be a summary code, or a reference to a very precise definition of the location, or both. Binding: approach-site-codes (example, A coded concept describing the site location the medicine enters into or onto the body.); (xsd)site:CodeableConcept>?
< How drug should enter body. Binding: route-codes (example, A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.); (xsd)route:CodeableConcept>?
< Technique for administering medication. Terminologies used often pre-coordinate this term with the route and or form of administration. Binding: administration-method-codes (example, A coded concept describing the technique by which the medicine is administered.); (xsd)method:CodeableConcept>?
[]< Depending on the resource,this is the amount of medication administered, to be administered or typical amount to be administered.; (xsd)doseAndRate:Dosage.doseAndRate>*
[]< 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".; (xsd)maxDosePerPeriod:Ratio>*
< 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.; (xsd)maxDosePerAdministration:SimpleQuantity>?
< Upper limit on medication per lifetime of the patient.; (xsd)maxDosePerLifetime:SimpleQuantity>?🔗 Depending on the resource,this is the amount of medication administered, to be administered or typical amount to be administered.Dosage.doseAndRate(xsd)(doc)=
<#base:Element>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< The kind of dose or rate specified, for example, ordered or calculated. Binding: http://terminology.hl7.org/ValueSet/dose-rate-type (example, The kind of dose or rate specified.); (xsd)type:CodeableConcept>?
< 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.; (xsd)dose:(<Range>
|<SimpleQuantity>)>?
< 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 grammar where ml/hour is included rather than a specific ratio where the time is specified as the denominator. Where a rate such as 500ml over 2 hours is specified, the use of rateRatio may be more semantically correct than specifying using a rateQuantity of 250 mg/hour.; (xsd)rate:(<Range>
|<Ratio>
|<SimpleQuantity>)>?🔗 Information about a medication that is used to support knowledge.DrugKnowledge(xsd)(doc)=
<#base:MedicationKnowledge>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< An Extension; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< Business identifier for this medication. This is a business identifier, not a resource identifier (see discussion).; (xsd)identifier:Identifier>*
< A code that specifies this medication, or a textual description if no code is available. Usage note: This could be a standard medication code such as a code from RxNorm, SNOMED CT, IDMP etc. It could also be a national or local formulary code, optionally with translations to other code systems. Depending on the context of use, the code that was actually selected by the user (prescriber, dispenser, etc.) will have the coding.userSelected set to true. As described in the coding datatype: "A coding may be marked as a "userSelected" if a user selected the particular coded value in a user interface (e.g. the user selects an item in a pick-list). If a user selected coding exists, it is the preferred choice for performing translations etc. Other codes can only be literal translations to alternative code systems, or codes at a lower level of granularity (e.g. a generic code for a vendor-specific primary one). Binding: medication-codes (example, A coded concept that defines the type of a medication.); (xsd)code:CodeableConcept>
< A code to indicate if the medication referred to by this MedicationKnowledge is in active use within the drug database or inventory system. The status refers to the validity about the information of the medication and not to its medicinal properties. This status is intended to identify if the medication in a local system is in active use within a drug database or inventory. For example, a pharmacy system may create a new drug file record for a compounded product "ABC Hospital Special Cream" with an active status. At some point in the future, it may be determined that the drug record was created with an error and the status is changed to "entered in error". This status is not intended to specify if a medication is part of a particular formulary. It is possible that the drug record may be referenced by multiple formularies or catalogues and each of those entries would have a separate status. Binding: medicationknowledge-status (required, A coded concept defining if the medication is in active use.); (xsd)status:code>?
< The creator or owner of the knowledge or information about the medication.; (xsd)author:Organization*>?
[]< Lists the jurisdictions that this medication knowledge was written for. The codes could have varying granularity from a country or group of countries down to a specific district.; (xsd)intendedJurisdiction:CodeableConcept>*
[]< All of the names for a medication, for example, the name(s) given to a medication in different countries. For example, acetaminophen and paracetamol or salbutamol and albuterol.; (xsd)name:string>*
[]< Associated or related medications. For example, if the medication is a branded product (e.g. Crestor), this is the Therapeutic Moeity (e.g. Rosuvastatin) or if this is a generic medication (e.g. Rosuvastatin), this would link to a branded product (e.g. Crestor.; (xsd)relatedMedicationKnowledge:DrugKnowledge.relatedMedicationKnowledge>*
[]< Links to associated medications that could be prescribed, dispensed or administered.; (xsd)associatedMedication:Medication*>*
[]< Category of the medication or product (e.g. branded product, therapeutic moeity, generic product, innovator product, etc.).; (xsd)productType:CodeableConcept>*
[]< Associated documentation about the medication.; (xsd)monograph:DrugKnowledge.monograph>*
< The instructions for preparing the medication.; (xsd)preparationInstruction:markdown>?
[]< The price of the medication.; (xsd)cost:DrugKnowledge.cost>*
[]< The program under which the medication is reviewed.; (xsd)monitoringProgram:DrugKnowledge.monitoringProgram>*
[]< Guidelines or protocols that are applicable for the administration of the medication based on indication.; (xsd)indicationGuideline:DrugKnowledge.indicationGuideline>*
[]< Categorization of the medication within a formulary or classification system.; (xsd)medicineClassification:DrugKnowledge.medicineClassification>*
[]< Information that only applies to packages (not products).; (xsd)packaging:DrugKnowledge.packaging>*
[]< Potential clinical issue with or between medication(s) (for example, drug-drug interaction, drug-disease contraindication, drug-allergy interaction, etc.).; (xsd)clinicalUseIssue:ClinicalUseDefinition*>*
[]< Information on how the medication should be stored, for example, refrigeration temperatures and length of stability at a given temperature.; (xsd)storageGuideline:DrugKnowledge.storageGuideline>*
[]< Regulatory information about a medication.; (xsd)regulatory:DrugKnowledge.regulatory>*
< Along with the link to a Medicinal Product Definition resource, this information provides common definitional elements that are needed to understand the specific medication that is being described.; (xsd)definitional:DrugKnowledge.definitional>?
[]< This extension to PlanDefinition, MedicationKnowledge and DeviceDefinition conveys the reference to a catalog containing the extended resource; (xsd)CatalogReference>*🔗 The price of the medication.DrugKnowledge.cost(xsd)(doc)=
<#base:MedicationKnowledge.cost>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< The date range for which the cost information of the medication is effective.; (xsd)effectiveDate:Period>*
< The category of the cost information. For example, manufacturers' cost, patient cost, claim reimbursement cost, actual acquisition cost.; (xsd)type:CodeableConcept>
< The source or owner that assigns the price to the medication.; (xsd)source:string>?
< The price or representation of the cost (for example, Band A, Band B or $, $$) of the medication. Binding: medication-cost-category (example, A coded concept defining the category of a medication.); (xsd)cost:(<CodeableConcept>
|<Money>)>🔗 Along with the link to a Medicinal Product Definition resource, this information provides common definitional elements that are needed to understand the specific medication that is being described.DrugKnowledge.definitional(xsd)(doc)=
<#base:MedicationKnowledge.definitional>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< Associated definitions for this medication.; (xsd)definition:MedicinalProductDefinition*>*
< Describes the form of the item. Powder; tablets; capsule. When Medication is referenced from MedicationRequest, this is the ordered form. When Medication is referenced within MedicationDispense, this is the dispensed form. When Medication is referenced within MedicationAdministration, this is administered form. Binding: medication-form-codes (example, ); (xsd)doseForm:CodeableConcept>?
[]< The intended or approved route of administration. Binding: route-codes (example, ); (xsd)intendedRoute:CodeableConcept>*
[]< Identifies a particular constituent of interest in the product.; (xsd)ingredient:DrugKnowledge.definitional.ingredient>*
[]< Specifies descriptive properties of the medicine, such as color, shape, imprints, etc.; (xsd)drugCharacteristic:DrugKnowledge.definitional.drugCharacteristic>*🔗 Specifies descriptive properties of the medicine, such as color, shape, imprints, etc.DrugKnowledge.definitional.drugCharacteristic(xsd)(doc)=
<#base:MedicationKnowledge.definitional.drugCharacteristic>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A code specifying which characteristic of the medicine is being described (for example, colour, shape, imprint). Binding: medicationknowledge-characteristic (example, ); (xsd)type:CodeableConcept>?
(<valueAttachment:Attachment>
|<valueBase64Binary:base64Binary>
|<valueCodeableConcept:CodeableConcept>
|<valueSimpleQuantity:SimpleQuantity>
|<valueString:string>)🔗 Identifies a particular constituent of interest in the product.DrugKnowledge.definitional.ingredient(xsd)(doc)=
<#base:MedicationKnowledge.definitional.ingredient>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A reference to the resource that provides information about the ingredient.; (xsd)item:Substance*>
< Indication of whether this ingredient affects the therapeutic action of the drug. Binding: http://terminology.hl7.org/ValueSet/v3-RoleClassIngredientEntity (example, ); (xsd)type:CodeableConcept>?
< Specifies how many (or how much) of the items there are in this Medication. For example, 250 mg per tablet. This is expressed as a ratio where the numerator is 250mg and the denominator is 1 tablet but can also be expressed a quantity when the denominator is assumed to be 1 tablet. Binding: medication-ingredientstrength (example, ); (xsd)strength:(<CodeableConcept>
|<Quantity>
|<Ratio>)>?🔗 Guidelines or protocols that are applicable for the administration of the medication based on indication.DrugKnowledge.indicationGuideline(xsd)(doc)=
<#base:MedicationKnowledge.indicationGuideline>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< Indication or reason for use of the medication that applies to the specific administration guideline.; (xsd)indication:ClinicalUseDefinition*>*
[]< The guidelines for the dosage of the medication for the indication.; (xsd)dosingGuideline:DrugKnowledge.indicationGuideline.dosingGuideline>*🔗 The guidelines for the dosage of the medication for the indication.DrugKnowledge.indicationGuideline.dosingGuideline(xsd)(doc)=
<#base:MedicationKnowledge.indicationGuideline.dosingGuideline>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The overall intention of the treatment, for example, prophylactic, supporative, curative, etc.; (xsd)treatmentIntent:CodeableConcept>?
[]< Dosage for the medication for the specific guidelines.; (xsd)dosage:DrugKnowledge.indicationGuideline.dosingGuideline.dosage>*
< The type of the treatment that the guideline applies to, for example, long term therapy, first line treatment, etc.; (xsd)administrationTreatment:CodeableConcept>?
[]< Characteristics of the patient that are relevant to the administration guidelines (for example, height, weight, gender, etc.).; (xsd)patientCharacteristic:DrugKnowledge.indicationGuideline.dosingGuideline.patientCharacteristic>*🔗 Dosage for the medication for the specific guidelines.DrugKnowledge.indicationGuideline.dosingGuideline.dosage(xsd)(doc)=
<#base:MedicationKnowledge.indicationGuideline.dosingGuideline.dosage>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The type or category of dosage for a given medication (for example, prophylaxis, maintenance, therapeutic, etc.).; (xsd)type:CodeableConcept>
[]< Dosage for the medication for the specific guidelines.; (xsd)dosage:Dosage>+🔗 Characteristics of the patient that are relevant to the administration guidelines (for example, height, weight, gender, etc.).DrugKnowledge.indicationGuideline.dosingGuideline.patientCharacteristic(xsd)(doc)=
<#base:MedicationKnowledge.indicationGuideline.dosingGuideline.patientCharacteristic>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The categorization of the specific characteristic that is relevant to the administration guideline (e.g. height, weight, gender).; (xsd)type:CodeableConcept>
(<valueCodeableConcept:CodeableConcept>
|<valueQuantity:Quantity>
|<valueRange:Range>)?🔗 Categorization of the medication within a formulary or classification system.DrugKnowledge.medicineClassification(xsd)(doc)=
<#base:MedicationKnowledge.medicineClassification>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The type of category for the medication (for example, therapeutic classification, therapeutic sub-classification).; (xsd)type:CodeableConcept>
< Either a textual source of the classification or a reference to an online source.; (xsd)source:(<string>
|<uri>)>?
[]< Specific category assigned to the medication (e.g. anti-infective, anti-hypertensive, antibiotic, etc.).; (xsd)classification:CodeableConcept>*🔗 The program under which the medication is reviewed.DrugKnowledge.monitoringProgram(xsd)(doc)=
<#base:MedicationKnowledge.monitoringProgram>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Type of program under which the medication is monitored.; (xsd)type:CodeableConcept>?
< Name of the reviewing program.; (xsd)name:string>?🔗 Associated documentation about the medication.DrugKnowledge.monograph(xsd)(doc)=
<#base:MedicationKnowledge.monograph>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The category of documentation about the medication. (e.g. professional monograph, patient education monograph).; (xsd)type:CodeableConcept>?
< Associated documentation about the medication.; (xsd)source:DocumentReference*>?🔗 Information that only applies to packages (not products).DrugKnowledge.packaging(xsd)(doc)=
<#base:MedicationKnowledge.packaging>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< The cost of the packaged medication.; (xsd)cost:MedicationKnowledge.cost>*
< A reference to a PackagedProductDefinition that provides the details of the product that is in the packaging and is being priced.; (xsd)packagedProduct:PackagedProductDefinition*>?🔗 Regulatory information about a medication.DrugKnowledge.regulatory(xsd)(doc)=
<#base:MedicationKnowledge.regulatory>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The authority that is specifying the regulations.; (xsd)regulatoryAuthority:Organization*>
[]< Specifies if changes are allowed when dispensing a medication from a regulatory perspective.; (xsd)substitution:DrugKnowledge.regulatory.substitution>*
[]< Specifies the schedule of a medication in jurisdiction.; (xsd)schedule:CodeableConcept>*
< The maximum number of units of the medication that can be dispensed in a period.; (xsd)maxDispense:DrugKnowledge.regulatory.maxDispense>?🔗 The maximum number of units of the medication that can be dispensed in a period.DrugKnowledge.regulatory.maxDispense(xsd)(doc)=
<#base:MedicationKnowledge.regulatory.maxDispense>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The maximum number of units of the medication that can be dispensed.; (xsd)quantity:SimpleQuantity>
< The period that applies to the maximum number of units.; (xsd)period:Duration>?🔗 Specifies if changes are allowed when dispensing a medication from a regulatory perspective.DrugKnowledge.regulatory.substitution(xsd)(doc)=
<#base:MedicationKnowledge.regulatory.substitution>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Specifies the type of substitution allowed.; (xsd)type:CodeableConcept>
< Specifies if regulation allows for changes in the medication when dispensing.; (xsd)allowed:boolean>🔗 Associated or related medications. For example, if the medication is a branded product (e.g. Crestor), this is the Therapeutic Moeity (e.g. Rosuvastatin) or if this is a generic medication (e.g. Rosuvastatin), this would link to a branded product (e.g. Crestor.DrugKnowledge.relatedMedicationKnowledge(xsd)(doc)=
<#base:MedicationKnowledge.relatedMedicationKnowledge>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The category of the associated medication knowledge reference.; (xsd)type:CodeableConcept>
[]< Associated documentation about the associated medication knowledge.; (xsd)reference:MedicationKnowledge*>+🔗 Information on how the medication should be stored, for example, refrigeration temperatures and length of stability at a given temperature.DrugKnowledge.storageGuideline(xsd)(doc)=
<#base:MedicationKnowledge.storageGuideline>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Reference to additional information about the storage guidelines.; (xsd)reference:uri>?
[]< Additional notes about the storage.; (xsd)note:Annotation>*
< Duration that the medication remains stable if the environmentalSetting is respected.; (xsd)stabilityDuration:Duration>?
[]< Describes a setting/value on the environment for the adequate storage of the medication and other substances. Environment settings may involve temperature, humidity, or exposure to light.; (xsd)environmentalSetting:DrugKnowledge.storageGuideline.environmentalSetting>*🔗 Describes a setting/value on the environment for the adequate storage of the medication and other substances. Environment settings may involve temperature, humidity, or exposure to light.DrugKnowledge.storageGuideline.environmentalSetting(xsd)(doc)=
<#base:MedicationKnowledge.storageGuideline.environmentalSetting>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Identifies the category or type of setting (e.g., type of location, temperature, humidity).; (xsd)type:CodeableConcept>
(<valueCodeableConcept:CodeableConcept>
|<valueQuantity:Quantity>
|<valueRange:Range>)🔗 A medically related item or items, in a container or package.DrugPackage(xsd)(doc)=
<#base:PackagedProductDefinition>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< A unique identifier for this package as whole - not the the content of the package. Unique instance identifiers assigned to a package by manufacturers, regulators, drug catalogue custodians or other organizations.; (xsd)identifier:Identifier>*
< A name for this package. Typically what it would be listed as in a drug formulary or catalogue, inventory etc.; (xsd)name:string>?
< A high level category e.g. medicinal product, raw material, shipping/transport container, etc. Binding: package-type (example, A high level categorisation of a package.); (xsd)type:CodeableConcept>
[]< The product this package model relates to, not the contents of the package (for which see package.containedItem).; (xsd)packageFor:MedicinalProductDefinition*>*
< The status within the lifecycle of this item. A high level status, this is not intended to duplicate details carried elsewhere such as legal status, or authorization or marketing status. Binding: publication-status (preferred, The lifecycle status of an artifact.); (xsd)status:CodeableConcept>?
< The date at which the given status became applicable.; (xsd)statusDate:dateTime>?
[]< A total of the complete count of contained items of a particular type/form, independent of sub-packaging or organization. This can be considered as the pack size. This attribute differs from containedItem.amount in that it can give a single aggregated count of all tablet types in a pack, even when these are different manufactured items. For example a pill pack of 21 tablets plus 7 sugar tablets, can be denoted here as '28 tablets'. This attribute is repeatable so that the different item types in one pack type can be counted (e.g. a count of vials and count of syringes). Each repeat must have different units, so that it is clear what the different sets of counted items are, and it is not intended to allow different counts of similar items (e.g. not '2 tubes and 3 tubes'). Repeats are not to be used to represent different pack sizes (e.g. 20 pack vs. 50 pack) - which would be different instances of this resource.; (xsd)containedItemQuantity:Quantity>*
< Textual description. Note that this is not the name of the package or product.; (xsd)description:markdown>?
[]< The legal status of supply of the packaged item as classified by the regulator.; (xsd)legalStatusOfSupply:DrugPackage.legalStatusOfSupply>*
[]< Allows specifying that an item is on the market for sale, or that it is not available, and the dates and locations associated.; (xsd)marketingStatus:MarketingStatus>*
< Identifies if the package contains different items, such as when a drug product is supplied with another item e.g. a diluent or adjuvant.; (xsd)copackagedIndicator:boolean>?
[]< Manufacturer of this package type. When there are multiple it means these are all possible manufacturers.; (xsd)manufacturer:Organization*>*
[]< Additional information or supporting documentation about the packaged product.; (xsd)attachedDocument:DocumentReference*>*
< A packaging item, as a container for medically related items, possibly with other packaging items within, or a packaging component, such as bottle cap (which is not a device or a medication manufactured item).; (xsd)packaging:DrugPackage.packaging>?
[]< Allows the key features to be recorded, such as "hospital pack", "nurse prescribable", "calendar pack".; (xsd)characteristic:PackagedProductDefinition.packaging.property>*🔗 The legal status of supply of the packaged item as classified by the regulator.DrugPackage.legalStatusOfSupply(xsd)(doc)=
<#base:PackagedProductDefinition.legalStatusOfSupply>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The actual status of supply. Conveys in what situation this package type may be supplied for use. Binding: legal-status-of-supply (example, The prescription supply types appropriate to a medicinal product); (xsd)code:CodeableConcept>?
< The place where the legal status of supply applies. When not specified, this indicates it is unknown in this context. Binding: jurisdiction (example, Jurisdiction codes); (xsd)jurisdiction:CodeableConcept>?🔗 A packaging item, as a container for medically related items, possibly with other packaging items within, or a packaging component, such as bottle cap (which is not a device or a medication manufactured item).DrugPackage.packaging(xsd)(doc)=
<#base:PackagedProductDefinition.packaging>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< A business identifier that is specific to this particular part of the packaging, often assigned by the manufacturer. Including possibly Data Carrier Identifier (a GS1 barcode).; (xsd)identifier:Identifier>*
< The physical type of the container of the items. Binding: packaging-type (example, A high level categorisation of a package.); (xsd)type:CodeableConcept>?
< Is this a part of the packaging (e.g. a cap or bottle stopper), rather than the packaging itself (e.g. a bottle or vial). The latter type are designed be a container, but the former are not.; (xsd)componentPart:boolean>?
< The quantity of packaging items contained at this layer of the package. This does not relate to the number of contained items but relates solely to the number of packaging items. When looking at the outermost layer it is always 1. If there are two boxes within, at the next layer it would be 2.; (xsd)quantity:integer>?
[]< Material type of the package item. Binding: package-material (example, A material used in the construction of packages and their components.); (xsd)material:CodeableConcept>*
[]< A possible alternate material for this part of the packaging, that is allowed to be used instead of the usual material (e.g. different types of plastic for a blister sleeve). Binding: package-material (example, A material used in the construction of packages and their components.); (xsd)alternateMaterial:CodeableConcept>*
[]< Shelf Life and storage information.; (xsd)shelfLifeStorage:ProductShelfLife>*
[]< Manufacturer of this packaging item. When there are multiple values each one is a potential manufacturer of this packaging item.; (xsd)manufacturer:Organization*>*
[]< General characteristics of this item.; (xsd)property:DrugPackage.packaging.property>*
[]< The item(s) within the packaging.; (xsd)containedItem:DrugPackage.packaging.containedItem>*
[]< Allows containers (and parts of containers) within containers, still as a part of a single packaged product. See also PackagedProductDefinition.packaging.containedItem.item(PackagedProductDefinition).; (xsd)packaging:PackagedProductDefinition.packaging>*🔗 The item(s) within the packaging.DrugPackage.packaging.containedItem(xsd)(doc)=
<#base:PackagedProductDefinition.packaging.containedItem>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The actual item(s) of medication, as manufactured, or a device (typically, but not necessarily, a co-packaged one), or other medically related item (such as food, biologicals, raw materials, medical fluids, gases etc.), as contained in the package. This also allows another whole packaged product to be included, which is solely for the case where a package of other entire packages is wanted - such as a wholesale or distribution pack (for layers within one package, use PackagedProductDefinition.packaging.packaging).; (xsd)item:(<BiologicallyDerivedProduct>
|<DeviceDefinition>
|<ManufacturedItemDefinition>
|<NutritionProduct>
|<PackagedProductDefinition>)>
< The number of this type of item within this packaging or for continuous items such as liquids it is the quantity (for example 25ml). See also PackagedProductDefinition.containedItemQuantity (especially the long definition).; (xsd)amount:Quantity>?🔗 General characteristics of this item.DrugPackage.packaging.property(xsd)(doc)=
<#base:PackagedProductDefinition.packaging.property>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A code expressing the type of characteristic. Binding: product-characteristic-codes (example, This value set includes all observable entity codes from SNOMED CT - provided as an exemplar value set.); (xsd)type:CodeableConcept>
(<valueAttachment:Attachment>
|<valueBoolean:boolean>
|<valueCodeableConcept:CodeableConcept>
|<valueDate:date>
|<valueQuantity:Quantity>)?🔗 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. Binding: duration-units (extensible, Appropriate units for Duration.)Duration(xsd)(doc)=
<#base:Quantity>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< 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).; (xsd)value:decimal>?
< 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. Binding: quantity-comparator (required, How the Quantity should be understood and represented.); (xsd)comparator:code>?
< A human-readable form of the unit.; (xsd)unit:string>?
< The identification of the system that provides the coded form of the unit.; (xsd)system:uri>?
< 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.; (xsd)code>?🔗 This Resource provides one or more comments, classifiers or ratings about a Resource and supports attribution and rights management metadata for the added content.ebmrecommendation(xsd)(doc)=
<#base:ArtifactAssessment>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< A formal identifier that is used to identify this artifact assessment when it is represented in other formats, or referenced in a specification, model, design or an instance. Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this activity definition outside of FHIR, where it is not possible to use the logical URI.; (xsd)identifier:Identifier>*
< A short title for the assessment for use in displaying and selecting.; (xsd)title:string>?
< Display of or reference to the bibliographic citation of the recommendation.; (xsd)citeAs:(<Citation>
|<markdown>)>?
< The date (and optionally time) when the artifact assessment was published. The date must change when the disposition changes and it must change if the workflow status code changes. In addition, it should change when the substantive content of the artifact assessment changes. The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the artifact assessment. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.; (xsd)date:dateTime>?
< A copyright statement relating to the artifact assessment and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the artifact assessment.; (xsd)copyright:markdown>?
< The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.; (xsd)approvalDate:date>?
< The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. If specified, this date follows the original approval date.; (xsd)lastReviewDate:date>?
< A reference to a resource, canonical resource, or non-FHIR resource which is the recommendation this comment or assessment is about.; (xsd)artifact:(<ActivityDefinition>
|<PlanDefinition>
|<Resource>
|<uri>)>
[]< A component comment, classifier, or rating of the artifact.; (xsd)content:ebmrecommendation.content>*
< Indicates the workflow status of the comment or change request. Binding: artifactassessment-workflow-status (required, ); (xsd)workflowStatus:code>{0,0}
< Indicates the disposition of the responsible party to the comment or change request. Binding: artifactassessment-disposition (required, ); (xsd)disposition:code>{0,0}🔗 A component comment, classifier, or rating of the artifact.ebmrecommendation.content(xsd)(doc)=
<#base:ArtifactAssessment.content>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The type of information this component of the content represents. Binding: artifactassessment-information-type (required, ); (xsd)informationType:code>?
< A brief summary of the content of this component.; (xsd)summary:markdown>?
< Indicates what type of content this component represents. Binding: certainty-type (example, ); (xsd)type:CodeableConcept>?
[]< Represents a rating, classifier, or assessment of the artifact. Binding: certainty-rating (example, ); (xsd)classifier:CodeableConcept>*
< A quantitative rating of the artifact.; (xsd)quantity:Quantity>?
< Indicates who or what authored the content.; (xsd)author:(<Device>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>)>?
[]< A URI that points to what the comment is about, such as a line of text in the CQL, or a specific element in a resource. The target element is used to point the comment to aspect of the artifact, such as a text range within a CQL library (e.g. #content?0:0-120:80).; (xsd)path:uri>*
[]< Additional related artifacts that provide supporting documentation, additional evidence, or further information related to the content.; (xsd)relatedArtifact:RelatedArtifact>*
< Acceptable to publicly share the comment, classifier or rating.; (xsd)freeToShare:boolean>?
[]< If the informationType is container, the components of the content.; (xsd)component:ArtifactAssessment.content>*🔗 Base definition for all elements in a resource.Element(xsd)(doc)=
<#base:Base>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*🔗 Captures constraints on each element within the resource, profile, or extension.ElementDefinition(xsd)(doc)=
<#base:BackboneType>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The path identifies the element and is expressed as a "."-separated list of ancestor elements, beginning with the name of the resource or extension.; (xsd)path:string>
[]< Codes that define how this element is represented in instances, when the deviation varies from the normal case. No extensions are allowed on elements with a representation of 'xmlAttr', no matter what FHIR serialization format is used. 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.). Binding: property-representation (required, How a property is represented when serialized.); (xsd)representation:code>*
< 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.).; (xsd)sliceName:string>?
< 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.; (xsd)sliceIsConstraining:boolean>?
< 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](http://hl7.org/fhir/extensions/StructureDefinition-elementdefinition-question.html).; (xsd)label:string>?
[]< 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. Binding: http://loinc.org/vs (example, Codes that indicate the meaning of a data element.); (xsd)code:Coding>*
< 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.; (xsd)slicing:ElementDefinition.slicing>?
< 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.; (xsd)short:string>?
< 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.; (xsd)definition:markdown>?
< 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.; (xsd)comment:markdown>?
< 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.; (xsd)requirements:markdown>?
[]< Identifies additional names by which this element might also be known.; (xsd)alias:string>*
< The minimum number of times this element SHALL appear in the instance.; (xsd)min:unsignedInt>?
< The maximum number of times this element is permitted to appear in the instance.; (xsd)max:string>?
< Information about the base definition of the element, provided to make it unnecessary for tools to trace the deviation of the element through the derived and related profiles. When the element definition is not the original definition of an element - e.g. either in a constraint on another type, or for elements from a super type in a snap shot - then the information in provided in the element definition may be different to the base definition. On the original definition of the element, it will be same. 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.; (xsd)base:ElementDefinition.base>?
< 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.; (xsd)contentReference:uri>?
[]< 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).; (xsd)type:ElementDefinition.type>*
< 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.; (xsd)defaultValue:(<Address>
|<Age>
|<Annotation>
|<Attachment>
|<Availability>
|<base64Binary>
|<boolean>
|<code>
|<CodeableConcept>
|<Coding>
|<ContactDetail>
|<ContactPoint>
|<Count>
|<DataRequirement>
|<date>
|<dateTime>
|<decimal>
|<Distance>
|<Dosage>
|<Duration>
|<Expression>
|<ExtendedContactDetail>
|<HumanName>
|<id>
|<Identifier>
|<instant>
|<integer>
|<integer64>
|<markdown>
|<Meta>
|<Money>
|<oid>
|<ParameterDefinition>
|<Period>
|<positiveInt>
|<Quantity>
|<Range>
|<Ratio>
|<RatioRange>
|<RelatedArtifact>
|<Resource>
|<SampledData>
|<Signature>
|<string>
|<time>
|<Timing>
|<TriggerDefinition>
|<unsignedInt>
|<uri>
|<url>
|<UsageContext>
|<uuid>)>?
< 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.; (xsd)meaningWhenMissing:markdown>?
< 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.; (xsd)orderMeaning:string>?
< Specifies a value that SHALL be exactly the value for this element in the instance, if present. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing. This is not recommended for Coding and CodeableConcept since these often have highly contextual properties such as version or display.; (xsd)fixed:(<Address>
|<Age>
|<Annotation>
|<Attachment>
|<Availability>
|<base64Binary>
|<boolean>
|<code>
|<CodeableConcept>
|<Coding>
|<ContactDetail>
|<ContactPoint>
|<Count>
|<DataRequirement>
|<date>
|<dateTime>
|<decimal>
|<Distance>
|<Dosage>
|<Duration>
|<Expression>
|<ExtendedContactDetail>
|<HumanName>
|<id>
|<Identifier>
|<instant>
|<integer>
|<integer64>
|<markdown>
|<Meta>
|<Money>
|<oid>
|<ParameterDefinition>
|<Period>
|<positiveInt>
|<Quantity>
|<Range>
|<Ratio>
|<RatioRange>
|<RelatedArtifact>
|<Resource>
|<SampledData>
|<Signature>
|<string>
|<time>
|<Timing>
|<TriggerDefinition>
|<unsignedInt>
|<uri>
|<url>
|<UsageContext>
|<uuid>)>?
< Specifies a value that each occurrence of the element in the instance SHALL follow - that is, any value in the pattern must be found in the instance, if the element has a value. Other additional values may be found too. This is effectively constraint by example.
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 an element within a pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] must (recursively) match at least one element from the instance array.
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
If a pattern[x] is declared on a repeating element, the pattern applies to all repetitions. If the desire is for a pattern to apply to only one element or a subset of elements, slicing must be used. See [Examples of Patterns](elementdefinition-examples.html#pattern-examples) for examples of pattern usage and the effect it will have. 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].; (xsd)pattern:(<Address>
|<Age>
|<Annotation>
|<Attachment>
|<Availability>
|<base64Binary>
|<boolean>
|<code>
|<CodeableConcept>
|<Coding>
|<ContactDetail>
|<ContactPoint>
|<Count>
|<DataRequirement>
|<date>
|<dateTime>
|<decimal>
|<Distance>
|<Dosage>
|<Duration>
|<Expression>
|<ExtendedContactDetail>
|<HumanName>
|<id>
|<Identifier>
|<instant>
|<integer>
|<integer64>
|<markdown>
|<Meta>
|<Money>
|<oid>
|<ParameterDefinition>
|<Period>
|<positiveInt>
|<Quantity>
|<Range>
|<Ratio>
|<RatioRange>
|<RelatedArtifact>
|<Resource>
|<SampledData>
|<Signature>
|<string>
|<time>
|<Timing>
|<TriggerDefinition>
|<unsignedInt>
|<uri>
|<url>
|<UsageContext>
|<uuid>)>?
[]< 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.; (xsd)example:ElementDefinition.example>*
< 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 a canonical minimum - e.g. you cannot provide 100mg if the minimum value is 10g.; (xsd)minValue:(<date>
|<dateTime>
|<decimal>
|<instant>
|<integer>
|<integer64>
|<positiveInt>
|<Quantity>
|<time>
|<unsignedInt>)>?
< 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 a canonical maximum - e.g. you cannot provide 10g if the maximum value is 50mg.; (xsd)maxValue:(<date>
|<dateTime>
|<decimal>
|<instant>
|<integer>
|<integer64>
|<positiveInt>
|<Quantity>
|<time>
|<unsignedInt>)>?
< Indicates the maximum length in characters that is permitted to be present in conformant instances and which is expected to be supported by conformant consumers that support the element. ```maxLength``` SHOULD only be used on primitive data types that have a string representation (see [http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics](http://hl7.org/fhir/extensions/StructureDefinition-structuredefinition-type-characteristics.html)). 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.; (xsd)maxLength:integer>?
[]< A reference to an invariant that may make additional statements about the cardinality or value in the instance.; (xsd)condition:id>*
[]< 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.; (xsd)constraint:ElementDefinition.constraint>*
< Specifies for a primitive data type that the value of the data type cannot be replaced by an extension. Typical extensions that can be provided in place of a the value are [http://hl7.org/fhir/StructureDefinition/data-absent-reason](http://hl7.org/fhir/extensions/StructureDefinition-data-absent-reason.html), [http://hl7.org/fhir/StructureDefinition/iso21090-nullFlavor](http://hl7.org/fhir/extensions/StructureDefinition-iso21090-nullFlavor.html), [http://hl7.org/fhir/StructureDefinition/originalText](http://hl7.org/fhir/extensions/StructureDefinition-originalText.html), and [http://hl7.org/fhir/StructureDefinition/cqf-expression](http://hl7.org/fhir/extensions/StructureDefinition-cqf-expression.html). Note that this element has no meaning when a value is provided, and extensions can be provided in addition to a value.; (xsd)mustHaveValue:boolean>?
[]< Specifies a list of extensions that can appear in place of a primitive value. if mustHaveValue is true, then this element should not be present, since no extensions are allowed in place of the value. Note that this element has no impact if the value is present.; (xsd)valueAlternatives:StructureDefinition*>*
< If true, implementations that produce or consume resources SHALL provide "support" for the element in some meaningful way. Note that this is being phased out and replaced by obligations (see below). If false, the element may be ignored and not supported. If false, whether to populate or use the data element in any way is at the discretion of the implementation. "Something meaningful" is context dependent and impossible to describe in the base FHIR specification. For this reason, the mustSupport flag is never set to true by the FHIR specification itself - it is only set to true in profiles. A profile on a type can always make mustSupport = true if it is false in the base type but cannot make mustSupport = false if it is true in the base type. This is done in [Resource Profiles](profiling.html#mustsupport), where the profile labels an element as mustSupport=true. When a profile does this, it SHALL also make clear exactly what kind of "support" is required, as this can mean many things. Note that an element that has the property IsModifier is not necessarily a "key" element (e.g. one of the important elements to make use of the resource), nor is it automatically mustSupport - however both of these things are more likely to be true for IsModifier elements than for other elements.; (xsd)mustSupport:boolean>?
< If true, the value of this element affects the interpretation of the element or resource that contains it, and the value of the element cannot be ignored. Typically, this is used for status, negation and qualification codes. The effect of this is that the element cannot be ignored by systems: they SHALL either recognize the element and process it, and/or a pre-determination has been made that it is not relevant to their particular system. When used on the root element in an extension definition, this indicates whether or not the extension is a modifier extension. Only the definition of an element can set IsModifier true - either the specification itself or where an extension is originally defined. Once set, it cannot be changed in derived profiles (except in the special case of the defining a new extension). An element/extension that has isModifier=true SHOULD also have a minimum cardinality of 1, so that there is no lack of clarity about what to do if it is missing. If it can be missing, the definition SHALL make the meaning of a missing element clear.; (xsd)isModifier:boolean>?
< Explains how that element affects the interpretation of the resource or element that contains it.; (xsd)isModifierReason:string>?
< 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. When a request is made with _summary=true, serializers only include elements marked as 'isSummary = true'. With a few exceptions (listed below), all datatype properties are included in the summary form. In resource and datatype definitions, if an element has a descendant marked as isSummary=true or if it satisfies both of the following conditions, it must be marked as isSummary=true:
* is at the root or has a parent that is 'mustSupport'
* has a minimum cardinality of 1 or is a modifier element
The following datatype properties are exceptions, and are not marked as isSummary:
* Attachment.data
* Signature.data, Signature.targetFormat, Signature.sigFormat
* Narrative.status, Narrative.div
* SampledData.data.; (xsd)isSummary:boolean>?
< 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.; (xsd)binding:ElementDefinition.binding>?
[]< Identifies a concept from an external specification that roughly corresponds to this element. Mappings are not necessarily specific enough for safe translation.; (xsd)mapping:ElementDefinition.mapping>*🔗 Information about the base definition of the element, provided to make it unnecessary for tools to trace the deviation of the element through the derived and related profiles. When the element definition is not the original definition of an element - e.g. either in a constraint on another type, or for elements from a super type in a snap shot - then the information in provided in the element definition may be different to the base definition. On the original definition of the element, it will be same. 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(xsd)(doc)=
<#base:Element>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< 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.; (xsd)path:string>
< 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).; (xsd)min:unsignedInt>
< 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.; (xsd)max:string>🔗 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(xsd)(doc)=
<#base:Element>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< 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). Binding: binding-strength (required, Indication of the degree of conformance expectations associated with a binding.); (xsd)strength:code>
< Describes the intended use of this particular set of codes.; (xsd)description:markdown>?
< 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).; (xsd)valueSet:ValueSet*>?
[]< Additional bindings that help applications implementing this element. Additional bindings do not replace the main binding but provide more information and/or context.; (xsd)additional:ElementDefinition.binding.additional>*🔗 Additional bindings that help applications implementing this element. Additional bindings do not replace the main binding but provide more information and/or context.ElementDefinition.binding.additional(xsd)(doc)=
<#base:Element>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< The use of this additional binding. Conformance bindings are in addition to the base binding, not instead of it. Binding: additional-binding-purpose (required, The use of an additional binding.); (xsd)purpose:code>
< The valueSet that is being bound for the purpose.; (xsd)valueSet:ValueSet*>
< Documentation of the purpose of use of the bindingproviding additional information about how it is intended to be used.; (xsd)documentation:markdown>?
< Concise documentation - for summary tables.; (xsd)shortDoco:string>?
[]< Qualifies the usage of the binding. Typically bindings are qualified by jurisdiction, but they may also be qualified by gender, workflow status, clinical domain etc. The information to decide whether a usege context applies is usually outside the resource, determined by context, and this might present challenges for validation tooling. This specification does not define exactly how the context is determined for the usage; typically, this will be described in implementation guides.; (xsd)usage:UsageContext>*
< Whether the binding applies to all repeats, or just to any one of them. This is only relevant for elements that can repeat. A common pattern is to make a conformance binding to all repeats, and then make a binding that one of the repeats must conform to.; (xsd)any:boolean>?🔗 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(xsd)(doc)=
<#base:Element>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< Allows identification of which elements have their cardinalities impacted by the constraint. Will not be referenced for constraints that do not affect cardinality.; (xsd)key:id>
< 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.; (xsd)requirements:markdown>?
< Identifies the impact constraint violation has on the conformance of the instance. This allows constraints to be asserted as "shall" (error) and "should" (warning). Binding: constraint-severity (required, SHALL applications comply with this constraint?); (xsd)severity:code>
< If true, indicates that the warning or best practice guideline should be suppressed. This element should only be present in a derived profile where a warning or hint has been determined to be spurious/incorrect. E.g. a warning encouraging the inclusion of an element that the profile explicitly prohibits.; (xsd)suppress:boolean>?
< 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.; (xsd)human:string>
< 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.; (xsd)expression:string>?
< 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.; (xsd)source:StructureDefinition*>?🔗 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(xsd)(doc)=
<#base:Element>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< Describes the purpose of this example among the set of examples.; (xsd)label:string>
(<valueAddress:Address>
|<valueAge:Age>
|<valueAnnotation:Annotation>
|<valueAttachment:Attachment>
|<valueAvailability:Availability>
|<valueBase64Binary:base64Binary>
|<valueBoolean:boolean>
|<valueCode:code>
|<valueCodeableConcept:CodeableConcept>
|<valueCoding:Coding>
|<valueContactDetail:ContactDetail>
|<valueContactPoint:ContactPoint>
|<valueCount:Count>
|<valueDataRequirement:DataRequirement>
|<valueDate:date>
|<valueDateTime:dateTime>
|<valueDecimal:decimal>
|<valueDistance:Distance>
|<valueDosage:Dosage>
|<valueDuration:Duration>
|<valueExpression:Expression>
|<valueExtendedContactDetail:ExtendedContactDetail>
|<valueHumanName:HumanName>
|<valueId:id>
|<valueIdentifier:Identifier>
|<valueInstant:instant>
|<valueInteger:integer>
|<valueInteger64:integer64>
|<valueMarkdown:markdown>
|<valueMeta:Meta>
|<valueMoney:Money>
|<valueOid:oid>
|<valueParameterDefinition:ParameterDefinition>
|<valuePeriod:Period>
|<valuePositiveInt:positiveInt>
|<valueQuantity:Quantity>
|<valueRange:Range>
|<valueRatio:Ratio>
|<valueRatioRange:RatioRange>
|<valueRelatedArtifact:RelatedArtifact>
|<valueResource:Resource>
|<valueSampledData:SampledData>
|<valueSignature:Signature>
|<valueString:string>
|<valueTime:time>
|<valueTiming:Timing>
|<valueTriggerDefinition:TriggerDefinition>
|<valueUnsignedInt:unsignedInt>
|<valueUri:uri>
|<valueUrl:url>
|<valueUsageContext:UsageContext>
|<valueUuid:uuid>)🔗 Identifies a concept from an external specification that roughly corresponds to this element. Mappings are not necessarily specific enough for safe translation.ElementDefinition.mapping(xsd)(doc)=
<#base:Element>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< An internal reference to the definition of a mapping.; (xsd)identity:id>
< Identifies the computable language in which mapping.map is expressed. If omitted, then there can be no expectation of computational interpretation of the mapping. Binding: mimetypes (required, BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)); (xsd)language:code>?
< 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.; (xsd)map:string>
< Comments that provide information about the mapping or its use.; (xsd)comment:markdown>?🔗 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(xsd)(doc)=
<#base:Element>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< 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.; (xsd)discriminator:ElementDefinition.slicing.discriminator>*
< 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.; (xsd)description:string>?
< 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.; (xsd)ordered:boolean>?
< 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. Binding: resource-slicing-rules (required, How slices are interpreted when evaluating an instance.); (xsd)rules:code>🔗 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(xsd)(doc)=
<#base:Element>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< How the element value is interpreted when discrimination is evaluated. 'pattern' is deprecated - it works exactly the same as 'value'. Binding: discriminator-type (required, How an element value is interpreted when discrimination is evaluated.); (xsd)type:code>
< A FHIRPath expression, using [the simple subset of FHIRPath](fhirpath.html#simple), that is used to identify the element on which discrimination is based.; (xsd)path:string>🔗 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(xsd)(doc)=
<#base:Element>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< 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). Binding: elementdefinition-types (extensible, List of all Types for ElementDefinition.type.code.); (xsd)code:uri>
[]< 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 [http://hl7.org/fhir/StructureDefinition/elementdefinition-profile-element](http://hl7.org/fhir/extensions/StructureDefinition-elementdefinition-profile-element.html) extension.; (xsd)profile:(<ImplementationGuide>
|<StructureDefinition>)>*
[]< 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.; (xsd)targetProfile:(<ImplementationGuide>
|<StructureDefinition>)>*
[]< 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. Binding: resource-aggregation-mode (required, How resource references can be aggregated.); (xsd)aggregation:code>*
< 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. Binding: reference-version-rules (required, Whether a reference needs to be version specific or version independent, or whether either can be used.); (xsd)versioning:code>?🔗 Captures constraints on each element within the resource, profile, or extension.elementdefinition-de(xsd)(doc)=
<#base:ElementDefinition>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The path identifies the element and is expressed as a "."-separated list of ancestor elements, beginning with the name of the resource or extension.; (xsd)path:string>
< Codes that define how this element is represented in instances, when the deviation varies from the normal case. No extensions are allowed on elements with a representation of 'xmlAttr', no matter what FHIR serialization format is used. 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.). Binding: property-representation (required, How a property is represented when serialized.); (xsd)representation:code>{0,0}
< 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.).; (xsd)sliceName:string>?
< 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.; (xsd)sliceIsConstraining:boolean>?
< 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](http://hl7.org/fhir/extensions/StructureDefinition-elementdefinition-question.html).; (xsd)label:string>?
[]< 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. Binding: http://loinc.org/vs (example, Codes that indicate the meaning of a data element.); (xsd)code:Coding>*
< 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.; (xsd)slicing:elementdefinition-de.slicing>{0,0}
< 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.; (xsd)short:string>{0,0}
< 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.; (xsd)definition:markdown>?
< 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.; (xsd)comment:markdown>?
< 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.; (xsd)requirements:markdown>?
[]< Identifies additional names by which this element might also be known.; (xsd)alias:string>*
< The minimum number of times this element SHALL appear in the instance.; (xsd)min:unsignedInt>?
< The maximum number of times this element is permitted to appear in the instance.; (xsd)max:string>?
< Information about the base definition of the element, provided to make it unnecessary for tools to trace the deviation of the element through the derived and related profiles. When the element definition is not the original definition of an element - e.g. either in a constraint on another type, or for elements from a super type in a snap shot - then the information in provided in the element definition may be different to the base definition. On the original definition of the element, it will be same. 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.; (xsd)base:elementdefinition-de.base>?
< 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.; (xsd)contentReference:uri>{0,0}
[]< 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).; (xsd)type:elementdefinition-de.type>*
< 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.
This element should only be used on child elements of complex data elements.; (xsd)defaultValue:(<Address>
|<Age>
|<Annotation>
|<Attachment>
|<Availability>
|<base64Binary>
|<boolean>
|<code>
|<CodeableConcept>
|<Coding>
|<ContactDetail>
|<ContactPoint>
|<Count>
|<DataRequirement>
|<date>
|<dateTime>
|<decimal>
|<Distance>
|<Dosage>
|<Duration>
|<Expression>
|<ExtendedContactDetail>
|<HumanName>
|<id>
|<Identifier>
|<instant>
|<integer>
|<integer64>
|<markdown>
|<Meta>
|<Money>
|<oid>
|<ParameterDefinition>
|<Period>
|<positiveInt>
|<Quantity>
|<Range>
|<Ratio>
|<RatioRange>
|<RelatedArtifact>
|<Resource>
|<SampledData>
|<Signature>
|<string>
|<time>
|<Timing>
|<TriggerDefinition>
|<unsignedInt>
|<uri>
|<url>
|<UsageContext>
|<uuid>)>?
< 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.
This element should only be used on child elements of complex data elements.; (xsd)meaningWhenMissing:markdown>?
< 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.; (xsd)orderMeaning:string>?
< Specifies a value that SHALL be exactly the value for this element in the instance, if present. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing. This is not recommended for Coding and CodeableConcept since these often have highly contextual properties such as version or display.; (xsd)fixed:(<Address>
|<Age>
|<Annotation>
|<Attachment>
|<Availability>
|<base64Binary>
|<boolean>
|<code>
|<CodeableConcept>
|<Coding>
|<ContactDetail>
|<ContactPoint>
|<Count>
|<DataRequirement>
|<date>
|<dateTime>
|<decimal>
|<Distance>
|<Dosage>
|<Duration>
|<Expression>
|<ExtendedContactDetail>
|<HumanName>
|<id>
|<Identifier>
|<instant>
|<integer>
|<integer64>
|<markdown>
|<Meta>
|<Money>
|<oid>
|<ParameterDefinition>
|<Period>
|<positiveInt>
|<Quantity>
|<Range>
|<Ratio>
|<RatioRange>
|<RelatedArtifact>
|<Resource>
|<SampledData>
|<Signature>
|<string>
|<time>
|<Timing>
|<TriggerDefinition>
|<unsignedInt>
|<uri>
|<url>
|<UsageContext>
|<uuid>)>{0,0}
< Specifies a value that each occurrence of the element in the instance SHALL follow - that is, any value in the pattern must be found in the instance, if the element has a value. Other additional values may be found too. This is effectively constraint by example.
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 an element within a pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] must (recursively) match at least one element from the instance array.
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
If a pattern[x] is declared on a repeating element, the pattern applies to all repetitions. If the desire is for a pattern to apply to only one element or a subset of elements, slicing must be used. See [Examples of Patterns](elementdefinition-examples.html#pattern-examples) for examples of pattern usage and the effect it will have. 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].; (xsd)pattern:(<Address>
|<Age>
|<Annotation>
|<Attachment>
|<Availability>
|<base64Binary>
|<boolean>
|<code>
|<CodeableConcept>
|<Coding>
|<ContactDetail>
|<ContactPoint>
|<Count>
|<DataRequirement>
|<date>
|<dateTime>
|<decimal>
|<Distance>
|<Dosage>
|<Duration>
|<Expression>
|<ExtendedContactDetail>
|<HumanName>
|<id>
|<Identifier>
|<instant>
|<integer>
|<integer64>
|<markdown>
|<Meta>
|<Money>
|<oid>
|<ParameterDefinition>
|<Period>
|<positiveInt>
|<Quantity>
|<Range>
|<Ratio>
|<RatioRange>
|<RelatedArtifact>
|<Resource>
|<SampledData>
|<Signature>
|<string>
|<time>
|<Timing>
|<TriggerDefinition>
|<unsignedInt>
|<uri>
|<url>
|<UsageContext>
|<uuid>)>{0,0}
[]< 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.; (xsd)example:elementdefinition-de.example>*
< 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 a canonical minimum - e.g. you cannot provide 100mg if the minimum value is 10g.; (xsd)minValue:(<date>
|<dateTime>
|<decimal>
|<instant>
|<integer>
|<integer64>
|<positiveInt>
|<Quantity>
|<time>
|<unsignedInt>)>?
< 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 a canonical maximum - e.g. you cannot provide 10g if the maximum value is 50mg.; (xsd)maxValue:(<date>
|<dateTime>
|<decimal>
|<instant>
|<integer>
|<integer64>
|<positiveInt>
|<Quantity>
|<time>
|<unsignedInt>)>?
< Indicates the maximum length in characters that is permitted to be present in conformant instances and which is expected to be supported by conformant consumers that support the element. ```maxLength``` SHOULD only be used on primitive data types that have a string representation (see [http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics](http://hl7.org/fhir/extensions/StructureDefinition-structuredefinition-type-characteristics.html)). 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.; (xsd)maxLength:integer>?
[]< A reference to an invariant that may make additional statements about the cardinality or value in the instance.; (xsd)condition:id>*
[]< 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.; (xsd)constraint:elementdefinition-de.constraint>*
< Specifies for a primitive data type that the value of the data type cannot be replaced by an extension. Typical extensions that can be provided in place of a the value are [http://hl7.org/fhir/StructureDefinition/data-absent-reason](http://hl7.org/fhir/extensions/StructureDefinition-data-absent-reason.html), [http://hl7.org/fhir/StructureDefinition/iso21090-nullFlavor](http://hl7.org/fhir/extensions/StructureDefinition-iso21090-nullFlavor.html), [http://hl7.org/fhir/StructureDefinition/originalText](http://hl7.org/fhir/extensions/StructureDefinition-originalText.html), and [http://hl7.org/fhir/StructureDefinition/cqf-expression](http://hl7.org/fhir/extensions/StructureDefinition-cqf-expression.html). Note that this element has no meaning when a value is provided, and extensions can be provided in addition to a value.; (xsd)mustHaveValue:boolean>?
[]< Specifies a list of extensions that can appear in place of a primitive value. if mustHaveValue is true, then this element should not be present, since no extensions are allowed in place of the value. Note that this element has no impact if the value is present.; (xsd)valueAlternatives:StructureDefinition*>*
< If true, implementations that produce or consume resources SHALL provide "support" for the element in some meaningful way. Note that this is being phased out and replaced by obligations (see below). If false, the element may be ignored and not supported. If false, whether to populate or use the data element in any way is at the discretion of the implementation. "Something meaningful" is context dependent and impossible to describe in the base FHIR specification. For this reason, the mustSupport flag is never set to true by the FHIR specification itself - it is only set to true in profiles. A profile on a type can always make mustSupport = true if it is false in the base type but cannot make mustSupport = false if it is true in the base type. This is done in [Resource Profiles](profiling.html#mustsupport), where the profile labels an element as mustSupport=true. When a profile does this, it SHALL also make clear exactly what kind of "support" is required, as this can mean many things. Note that an element that has the property IsModifier is not necessarily a "key" element (e.g. one of the important elements to make use of the resource), nor is it automatically mustSupport - however both of these things are more likely to be true for IsModifier elements than for other elements.; (xsd)mustSupport:boolean>?
< If true, the value of this element affects the interpretation of the element or resource that contains it, and the value of the element cannot be ignored. Typically, this is used for status, negation and qualification codes. The effect of this is that the element cannot be ignored by systems: they SHALL either recognize the element and process it, and/or a pre-determination has been made that it is not relevant to their particular system. When used on the root element in an extension definition, this indicates whether or not the extension is a modifier extension. Only the definition of an element can set IsModifier true - either the specification itself or where an extension is originally defined. Once set, it cannot be changed in derived profiles (except in the special case of the defining a new extension). An element/extension that has isModifier=true SHOULD also have a minimum cardinality of 1, so that there is no lack of clarity about what to do if it is missing. If it can be missing, the definition SHALL make the meaning of a missing element clear.; (xsd)isModifier:boolean>{0,0}
< Explains how that element affects the interpretation of the resource or element that contains it.; (xsd)isModifierReason:string>?
< 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. When a request is made with _summary=true, serializers only include elements marked as 'isSummary = true'. With a few exceptions (listed below), all datatype properties are included in the summary form. In resource and datatype definitions, if an element has a descendant marked as isSummary=true or if it satisfies both of the following conditions, it must be marked as isSummary=true:
* is at the root or has a parent that is 'mustSupport'
* has a minimum cardinality of 1 or is a modifier element
The following datatype properties are exceptions, and are not marked as isSummary:
* Attachment.data
* Signature.data, Signature.targetFormat, Signature.sigFormat
* Narrative.status, Narrative.div
* SampledData.data.; (xsd)isSummary:boolean>{0,0}
< 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.; (xsd)binding:elementdefinition-de.binding>?
[]< Identifies a concept from an external specification that roughly corresponds to this element. Mappings are not necessarily specific enough for safe translation.; (xsd)mapping:elementdefinition-de.mapping>*
[]< The default/suggested phrasing to use when prompting a human to capture the data element in question form (e.g. In a survey). Question and label serve similar purposes in they both can be used to prompt for capturing a data element. Whether the question form or label form should be used will depend on the type of instrument being used to capture the information. The ordering is in order of preference. I.e. Most preferred question form is listed first. Note that this is for alternate phrasings of the question. Language translations are handled using the ISO 21090 string translation extensions.; (xsd)Question:Extension>*
< Identifies the units of measure in which the element should be captured or expressed. Use a value set if more than one unit of measure is possible. Value sets will typically be short enough to display in a drop-down selection list.; (xsd)AllowedUnits:Extension>?🔗 Information about the base definition of the element, provided to make it unnecessary for tools to trace the deviation of the element through the derived and related profiles. When the element definition is not the original definition of an element - e.g. either in a constraint on another type, or for elements from a super type in a snap shot - then the information in provided in the element definition may be different to the base definition. On the original definition of the element, it will be same. 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-de.base(xsd)(doc)=
<#base:ElementDefinition.base>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< 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.; (xsd)path:string>
< 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).; (xsd)min:unsignedInt>
< 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.; (xsd)max:string>🔗 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-de.binding(xsd)(doc)=
<#base:ElementDefinition.binding>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< 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). Binding: binding-strength (required, Indication of the degree of conformance expectations associated with a binding.); (xsd)strength:code>
< Describes the intended use of this particular set of codes.; (xsd)description:markdown>?
< 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).; (xsd)valueSet:ValueSet*>?
[]< Additional bindings that help applications implementing this element. Additional bindings do not replace the main binding but provide more information and/or context.; (xsd)additional:elementdefinition-de.binding.additional>*🔗 Additional bindings that help applications implementing this element. Additional bindings do not replace the main binding but provide more information and/or context.elementdefinition-de.binding.additional(xsd)(doc)=
<#base:ElementDefinition.binding.additional>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< The use of this additional binding. Conformance bindings are in addition to the base binding, not instead of it. Binding: additional-binding-purpose (required, The use of an additional binding.); (xsd)purpose:code>
< The valueSet that is being bound for the purpose.; (xsd)valueSet:ValueSet*>
< Documentation of the purpose of use of the bindingproviding additional information about how it is intended to be used.; (xsd)documentation:markdown>?
< Concise documentation - for summary tables.; (xsd)shortDoco:string>?
[]< Qualifies the usage of the binding. Typically bindings are qualified by jurisdiction, but they may also be qualified by gender, workflow status, clinical domain etc. The information to decide whether a usege context applies is usually outside the resource, determined by context, and this might present challenges for validation tooling. This specification does not define exactly how the context is determined for the usage; typically, this will be described in implementation guides.; (xsd)usage:UsageContext>*
< Whether the binding applies to all repeats, or just to any one of them. This is only relevant for elements that can repeat. A common pattern is to make a conformance binding to all repeats, and then make a binding that one of the repeats must conform to.; (xsd)any:boolean>?🔗 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-de.constraint(xsd)(doc)=
<#base:ElementDefinition.constraint>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< Allows identification of which elements have their cardinalities impacted by the constraint. Will not be referenced for constraints that do not affect cardinality.; (xsd)key:id>
< 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.; (xsd)requirements:markdown>?
< Identifies the impact constraint violation has on the conformance of the instance. This allows constraints to be asserted as "shall" (error) and "should" (warning). Binding: constraint-severity (required, SHALL applications comply with this constraint?); (xsd)severity:code>
< If true, indicates that the warning or best practice guideline should be suppressed. This element should only be present in a derived profile where a warning or hint has been determined to be spurious/incorrect. E.g. a warning encouraging the inclusion of an element that the profile explicitly prohibits.; (xsd)suppress:boolean>?
< 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.; (xsd)human:string>
< 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.; (xsd)expression:string>?
< 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.; (xsd)source:StructureDefinition*>?🔗 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-de.example(xsd)(doc)=
<#base:ElementDefinition.example>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< Describes the purpose of this example among the set of examples.; (xsd)label:string>
(<valueAddress:Address>
|<valueAge:Age>
|<valueAnnotation:Annotation>
|<valueAttachment:Attachment>
|<valueAvailability:Availability>
|<valueBase64Binary:base64Binary>
|<valueBoolean:boolean>
|<valueCode:code>
|<valueCodeableConcept:CodeableConcept>
|<valueCoding:Coding>
|<valueContactDetail:ContactDetail>
|<valueContactPoint:ContactPoint>
|<valueCount:Count>
|<valueDataRequirement:DataRequirement>
|<valueDate:date>
|<valueDateTime:dateTime>
|<valueDecimal:decimal>
|<valueDistance:Distance>
|<valueDosage:Dosage>
|<valueDuration:Duration>
|<valueExpression:Expression>
|<valueExtendedContactDetail:ExtendedContactDetail>
|<valueHumanName:HumanName>
|<valueId:id>
|<valueIdentifier:Identifier>
|<valueInstant:instant>
|<valueInteger:integer>
|<valueInteger64:integer64>
|<valueMarkdown:markdown>
|<valueMeta:Meta>
|<valueMoney:Money>
|<valueOid:oid>
|<valueParameterDefinition:ParameterDefinition>
|<valuePeriod:Period>
|<valuePositiveInt:positiveInt>
|<valueQuantity:Quantity>
|<valueRange:Range>
|<valueRatio:Ratio>
|<valueRatioRange:RatioRange>
|<valueRelatedArtifact:RelatedArtifact>
|<valueResource:Resource>
|<valueSampledData:SampledData>
|<valueSignature:Signature>
|<valueString:string>
|<valueTime:time>
|<valueTiming:Timing>
|<valueTriggerDefinition:TriggerDefinition>
|<valueUnsignedInt:unsignedInt>
|<valueUri:uri>
|<valueUrl:url>
|<valueUsageContext:UsageContext>
|<valueUuid:uuid>)🔗 Identifies a concept from an external specification that roughly corresponds to this element. Mappings are not necessarily specific enough for safe translation.elementdefinition-de.mapping(xsd)(doc)=
<#base:ElementDefinition.mapping>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< An internal reference to the definition of a mapping.; (xsd)identity:id>
< Identifies the computable language in which mapping.map is expressed. If omitted, then there can be no expectation of computational interpretation of the mapping. Binding: mimetypes (required, BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)); (xsd)language:code>?
< 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.; (xsd)map:string>
< Comments that provide information about the mapping or its use.; (xsd)comment:markdown>?🔗 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-de.slicing(xsd)(doc)=
<#base:ElementDefinition.slicing>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< 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.; (xsd)discriminator:elementdefinition-de.slicing.discriminator>*
< 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.; (xsd)description:string>?
< 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.; (xsd)ordered:boolean>?
< 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. Binding: resource-slicing-rules (required, How slices are interpreted when evaluating an instance.); (xsd)rules:code>🔗 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-de.slicing.discriminator(xsd)(doc)=
<#base:ElementDefinition.slicing.discriminator>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< How the element value is interpreted when discrimination is evaluated. 'pattern' is deprecated - it works exactly the same as 'value'. Binding: discriminator-type (required, How an element value is interpreted when discrimination is evaluated.); (xsd)type:code>
< A FHIRPath expression, using [the simple subset of FHIRPath](fhirpath.html#simple), that is used to identify the element on which discrimination is based.; (xsd)path:string>🔗 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-de.type(xsd)(doc)=
<#base:ElementDefinition.type>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< 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). Binding: elementdefinition-types (extensible, List of all Types for ElementDefinition.type.code.); (xsd)code:uri>
< 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 [http://hl7.org/fhir/StructureDefinition/elementdefinition-profile-element](http://hl7.org/fhir/extensions/StructureDefinition-elementdefinition-profile-element.html) extension.; (xsd)profile:(<ImplementationGuide>
|<StructureDefinition>)>{0,0}
[]< 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.; (xsd)targetProfile:(<ImplementationGuide>
|<StructureDefinition>)>*
< 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. Binding: resource-aggregation-mode (required, How resource references can be aggregated.); (xsd)aggregation:code>{0,0}
< 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. Binding: reference-version-rules (required, Whether a reference needs to be version specific or version independent, or whether either can be used.); (xsd)versioning:code>?🔗 The Library resource is a general-purpose container for knowledge asset definitions. It can be used to describe and expose existing knowledge assets such as logic libraries and information model descriptions, as well as to describe a collection of knowledge assets.elmlibrary(xsd)(doc)=
<#base:logiclibrary>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< An Extension; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< An absolute URI that is used to identify this library when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this library is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the library is stored on different servers. Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.
The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions).
In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.; (xsd)url:uri>
[]< A formal identifier that is used to identify this library when it is represented in other formats, or referenced in a specification, model, design or an instance. e.g. CMS or NQF identifiers for a measure artifact. Note that at least one identifier is required for non-experimental active artifacts. Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this library outside of FHIR, where it is not possible to use the logical URI.; (xsd)identifier:Identifier>*
< The identifier that is used to identify this version of the library when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the library author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts. There may be different library instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the library with the format [url]|[version]. The version SHOULD NOT contain a '#' - see [Business Version](resource.html#bv-format).; (xsd)version:string>
< Indicates the mechanism used to compare versions to determine which is more current. If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined. Binding: version-algorithm (extensible, ); (xsd)versionAlgorithm:(<Coding>
|<string>)>?
< A natural language name identifying the library. This name should be usable as an identifier for the module by machine processing applications such as code generation. The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.; (xsd)name:string>?
< A short, descriptive, user-friendly title for the library. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.; (xsd)title:string>
< An explanatory or alternate title for the library giving additional information about its content.; (xsd)subtitle:string>?
< The status of this library. Enables tracking the life-cycle of the content. Allows filtering of libraries that are appropriate for use vs. not.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization). Binding: publication-status (required, The lifecycle status of an artifact.); (xsd)status:code>
< A Boolean value to indicate that this library is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. Allows filtering of librarys that are appropriate for use versus not.; (xsd)experimental:boolean>?
< Identifies the type of library such as a Logic Library, Model Definition, Asset Collection, or Module Definition. Binding: library-type (extensible, The type of knowledge asset this library contains.); (xsd)type:CodeableConcept>
< A code or group definition that describes the intended subject of the contents of the library. Binding: participant-resource-types (extensible, The possible types of subjects for a library (E.g. Patient, Practitioner, Organization, Location, etc.).); (xsd)subject:(<CodeableConcept>
|<Group>)>?
< The date (and optionally time) when the library was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the library changes. The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the library. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)date:dateTime>?
< The name of the organization or individual responsible for the release and ongoing maintenance of the library. Usually an organization but may be an individual. The publisher (or steward) of the library is the organization or individual primarily responsible for the maintenance and upkeep of the library. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the library. This item SHOULD be populated unless the information is available from context.; (xsd)publisher:string>?
[]< Contact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)contact:ContactDetail>*
< A free text natural language description of the library from a consumer's perspective. This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the library as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the library is presumed to be the predominant language in the place the library was created).; (xsd)description:markdown>
[]< The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate library instances. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.; (xsd)useContext:UsageContext>*
[]< A legal or geographic region in which the library is intended to be used. It may be possible for the library to be used in jurisdictions other than those for which it was originally designed or intended.
DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.) Binding: jurisdiction (extensible, Countries and regions within which this artifact is targeted for use.); (xsd)jurisdiction:CodeableConcept>*
< Explanation of why this library is needed and why it has been designed as it has. This element does not describe the usage of the library. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this library.; (xsd)purpose:markdown>?
< A detailed description of how the library is used from a clinical perspective.; (xsd)usage:markdown>?
< A copyright statement relating to the library and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the library. The short copyright declaration (e.g. (c) '2015+ xyz organization' should be sent in the copyrightLabel element.; (xsd)copyright:markdown>?
< A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved'). The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.; (xsd)copyrightLabel:string>?
< The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)approvalDate:date>?
< The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. If specified, this date follows the original approval date.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)lastReviewDate:date>?
< The period during which the library content was or is planned to be in active use. The effective period for a library determines when the content is applicable for usage and is independent of publication and review dates. For example, a library intended to be used for the year 2016 might be published in 2015.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)effectivePeriod:Period>?
[]< Descriptive topics related to the content of the library. Topics provide a high-level categorization of the library that can be useful for filtering and searching. DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'topic' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#topic and useContext.valueCodeableConcept indicating the topic) Binding: definition-topic (example, High-level categorization of the definition, used for searching, sorting, and filtering.); (xsd)topic:CodeableConcept>*
[]< An individiual or organization primarily involved in the creation and maintenance of the content.; (xsd)author:ContactDetail>*
[]< An individual or organization primarily responsible for internal coherence of the content.; (xsd)editor:ContactDetail>*
[]< An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the content. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)reviewer:ContactDetail>*
[]< An individual or organization asserted by the publisher to be responsible for officially endorsing the content for use in some setting. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)endorser:ContactDetail>*
[]< Related artifacts such as additional documentation, justification, or bibliographic references. Each related artifact is either an attachment, or a reference to another resource, but not both.; (xsd)relatedArtifact:RelatedArtifact>*
[]< The parameter element defines parameters used by the library.; (xsd)parameter:ParameterDefinition>*
[]< Describes a set of data that must be provided in order to be able to successfully perform the computations defined by the library.; (xsd)dataRequirement:DataRequirement>*
[]< The content of the library as an Attachment. The content may be a reference to a url, or may be directly embedded as a base-64 string. Either way, the contentType of the attachment determines how to interpret the content.; (xsd)content:elmlibrary.content>*
[]< Defines a knowledge capability afforded by this knowledge artifact.; (xsd)knowledgeCapability:Extension>*
[]< Defines a knowledge representation level provided by this knowledge artifact.; (xsd)knowledgeRepresentationLevel:Extension>*
[]< A comment containing additional documentation, a review comment, usage guidance, or other relevant information from a particular user.; (xsd)artifactComment:Extension>*
[]< Defines a code directly referenced by artifact logic, as opposed to a value set. Direct reference codes may be the target of data requirements.; (xsd)directReferenceCode:Extension>*
[]< Related artifacts such as additional documentation, justification, or bibliographic references. Each related artifact is either an attachment, or a reference to another resource, but not both.; (xsd)dependency:elmlibrary.dependency>*
[]< The ELM XML translation of the CQL content represented as base-64 encoded data.; (xsd)elmXmlContent:elmlibrary.elmXmlContent>*
[]< The ELM JSON translation of the CQL content represented as base-64 encoded data.; (xsd)elmJsonContent:elmlibrary.elmJsonContent>*🔗 The content of the library as an Attachment. The content may be a reference to a url, or may be directly embedded as a base-64 string. Either way, the contentType of the attachment determines how to interpret the content.elmlibrary.content(xsd)(doc)=
<#base:logiclibrary.content>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< 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. Binding: mimetypes (required, BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)); (xsd)contentType:code>?
< The human language of the content. The value can be any valid value according to BCP 47. Binding: all-languages (required, IETF language tag for a human language.); (xsd)language:code>?
< 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.; (xsd)data:base64Binary>?
< 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.; (xsd)url>?
< 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.; (xsd)size:integer64>?
< 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.; (xsd)hash:base64Binary>?
< A label or set of text to display in place of the data. May sometimes be derived from the source filename.; (xsd)title:string>?
< The date that the attachment was first created.; (xsd)creation:dateTime>?
< Height of the image in pixels (photo/video).; (xsd)height:positiveInt>?
< Width of the image in pixels (photo/video).; (xsd)width:positiveInt>?
< The number of frames in a photo. This is used with a multi-page fax, or an imaging acquisition context that takes multiple slices in a single image, or an animated gif. If there is more than one frame, this SHALL have a value in order to alert interface software that a multi-frame capable rendering widget is required. if the number of frames is not supplied, the value may be unknown. Applications should not assume that there is only one frame unless it is explicitly stated.; (xsd)frames:positiveInt>?
< The duration of the recording in seconds - for audio and video. The duration might differ from occurrencePeriod if recording was paused.; (xsd)duration:decimal>?
< The number of pages when printed.; (xsd)pages:positiveInt>?🔗 Related artifacts such as additional documentation, justification, or bibliographic references. Each related artifact is either an attachment, or a reference to another resource, but not both.elmlibrary.dependency(xsd)(doc)=
<#base:logiclibrary.dependency>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< The type of relationship to the related artifact. The presence of both sides of a relationship type (e.g. successor and predecessor) is required to support use cases where one side of a relationship is not represented in FHIR. However, this feature SHALL NOT be used to create bi-directional resource links in FHIR instances. Specifically, following the methodology of "new points to old" and "many points to one", when using related artifact elements to describe and reference FHIR resources, the type element SHALL be drawn from the fhir-related-artifact-type ValueSet. Binding: related-artifact-type (required, The type of relationship to the related artifact.) depends-on; (xsd)type:code>
[]< Provides additional classifiers of the related artifact. Binding: citation-artifact-classifier (example, Additional classifiers for the related artifact.); (xsd)classifier:CodeableConcept>*
< A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index.; (xsd)label:string>?
< A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.; (xsd)display:string>?
< 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.; (xsd)citation:markdown>?
< The document being referenced, represented as an attachment. This is exclusive with the resource element.; (xsd)document:Attachment>?
< The related artifact, 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.; (xsd)resource:(<CodeSystem>
|<Library>
|<ValueSet>)>
< The related artifact, if the artifact is not a canonical resource, or a resource reference to a canonical resource. If both resource and resourceReference are present, they SHOULD be consistent and reference the same resource. Although relatedArtifact is intended to support references to definitional resources, there are cases where non-definitional resources can be definitional (such as Location where the kind is mode). Related artifacts SHOULD be used to reference definitional resources, and profiles SHOULD be used to make that explicit for particular use cases.; (xsd)resourceReference:Resource*>?
< The publication status of the artifact being referred to. Binding: publication-status (required, Publication status of an artifact being referred to.); (xsd)publicationStatus:code>?
< The date of publication of the artifact being referred to.; (xsd)publicationDate:date>?🔗 The ELM JSON translation of the CQL content represented as base-64 encoded data.elmlibrary.elmJsonContent(xsd)(doc)=
<#base:Attachment>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< 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. Binding: mimetypes (required, BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)) application/elm+json; (xsd)contentType:code>?
< The human language of the content. The value can be any valid value according to BCP 47. Binding: all-languages (required, IETF language tag for a human language.); (xsd)language:code>?
< 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.; (xsd)data:base64Binary>
< 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.; (xsd)url>?
< 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.; (xsd)size:integer64>?
< 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.; (xsd)hash:base64Binary>?
< A label or set of text to display in place of the data. May sometimes be derived from the source filename.; (xsd)title:string>?
< The date that the attachment was first created.; (xsd)creation:dateTime>?
< Height of the image in pixels (photo/video).; (xsd)height:positiveInt>?
< Width of the image in pixels (photo/video).; (xsd)width:positiveInt>?
< The number of frames in a photo. This is used with a multi-page fax, or an imaging acquisition context that takes multiple slices in a single image, or an animated gif. If there is more than one frame, this SHALL have a value in order to alert interface software that a multi-frame capable rendering widget is required. if the number of frames is not supplied, the value may be unknown. Applications should not assume that there is only one frame unless it is explicitly stated.; (xsd)frames:positiveInt>?
< The duration of the recording in seconds - for audio and video. The duration might differ from occurrencePeriod if recording was paused.; (xsd)duration:decimal>?
< The number of pages when printed.; (xsd)pages:positiveInt>?🔗 The ELM XML translation of the CQL content represented as base-64 encoded data.elmlibrary.elmXmlContent(xsd)(doc)=
<#base:Attachment>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< 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. Binding: mimetypes (required, BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)) application/elm+xml; (xsd)contentType:code>?
< The human language of the content. The value can be any valid value according to BCP 47. Binding: all-languages (required, IETF language tag for a human language.); (xsd)language:code>?
< 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.; (xsd)data:base64Binary>
< 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.; (xsd)url>?
< 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.; (xsd)size:integer64>?
< 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.; (xsd)hash:base64Binary>?
< A label or set of text to display in place of the data. May sometimes be derived from the source filename.; (xsd)title:string>?
< The date that the attachment was first created.; (xsd)creation:dateTime>?
< Height of the image in pixels (photo/video).; (xsd)height:positiveInt>?
< Width of the image in pixels (photo/video).; (xsd)width:positiveInt>?
< The number of frames in a photo. This is used with a multi-page fax, or an imaging acquisition context that takes multiple slices in a single image, or an animated gif. If there is more than one frame, this SHALL have a value in order to alert interface software that a multi-frame capable rendering widget is required. if the number of frames is not supplied, the value may be unknown. Applications should not assume that there is only one frame unless it is explicitly stated.; (xsd)frames:positiveInt>?
< The duration of the recording in seconds - for audio and video. The duration might differ from occurrencePeriod if recording was paused.; (xsd)duration:decimal>?
< The number of pages when printed.; (xsd)pages:positiveInt>?🔗 An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient. Encounter is primarily used to record information about the actual activities that occurred, where Appointment is used to record planned activities.Encounter(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< Identifier(s) by which this encounter is known.; (xsd)identifier:Identifier>*
< The current state of the encounter (not the state of the patient within the encounter - that is subjectState). Note that internal business rules will determine the appropriate transitions that may occur between statuses (and also classes). Binding: encounter-status (required, Current state of the encounter.); (xsd)status:code>
[]< Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations. Binding: http://terminology.hl7.org/ValueSet/encounter-class (preferred, Classification of the encounter.); (xsd)class:CodeableConcept>*
< Indicates the urgency of the encounter. Binding: http://terminology.hl7.org/ValueSet/v3-ActPriority (example, Indicates the urgency of the encounter.); (xsd)priority:CodeableConcept>?
[]< Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation). Since there are many ways to further classify encounters, this element is 0..*. Binding: encounter-type (example, A specific code indicating type of service provided); (xsd)type:CodeableConcept>*
[]< Broad categorization of the service that is to be provided (e.g. cardiology). Binding: service-type (example, Broad categorization of the service that is to be provided.); (xsd)serviceType:HealthcareService*>*
< The patient or group related to this encounter. In some use-cases the patient MAY not be present, such as a case meeting about a patient between several practitioners or a careteam. While the encounter is always about the patient, the patient might not actually be known in all contexts of use, and there may be a group of patients that could be anonymous (such as in a group therapy for Alcoholics Anonymous - where the recording of the encounter could be used for billing on the number of people/staff and not important to the context of the specific patients) or alternately in veterinary care a herd of sheep receiving treatment (where the animals are not individually tracked).; (xsd)subject:(<Group>
|<Patient>)>?
< The subjectStatus value can be used to track the patient's status within the encounter. It details whether the patient has arrived or departed, has been triaged or is currently in a waiting status. Different use-cases are likely to have different permitted transitions between states, such as an Emergency department could use `arrived` when the patient first presents, then `triaged` once has been assessed by a nurse, then `receiving-care` once treatment begins, however other sectors may use a different set of these values, or their own custom set in place of this example valueset provided. Binding: encounter-subject-status (example, Current status of the subject within the encounter.); (xsd)subjectStatus:CodeableConcept>?
[]< Where a specific encounter should be classified as a part of a specific episode(s) of care this field should be used. This association can facilitate grouping of related encounters together for a specific purpose, such as government reporting, issue tracking, association via a common problem. The association is recorded on the encounter as these are typically created after the episode of care and grouped on entry rather than editing the episode of care to append another encounter to it (the episode of care could span years).; (xsd)episodeOfCare:EpisodeOfCare*>*
[]< The request this encounter satisfies (e.g. incoming referral or procedure request).; (xsd)basedOn:(<CarePlan>
|<DeviceRequest>
|<MedicationRequest>
|<ServiceRequest>)>*
[]< The group(s) of individuals, organizations that are allocated to participate in this encounter. The participants backbone will record the actuals of when these individuals participated during the encounter.; (xsd)careTeam:CareTeam*>*
< Another Encounter of which this encounter is a part of (administratively or in time). This is also used for associating a child's encounter back to the mother's encounter.
Refer to the Notes section in the Patient resource for further details.; (xsd)partOf:Encounter*>?
< The organization that is primarily responsible for this Encounter's services. This MAY be the same as the organization on the Patient record, however it could be different, such as if the actor performing the services was from an external organization (which may be billed seperately) for an external consultation. Refer to the colonoscopy example on the Encounter examples tab.; (xsd)serviceProvider:Organization*>?
[]< The list of people responsible for providing the service. Any Patient or Group present in the participation.actor must also be the subject, though the subject may be absent from the participation.actor for cases where the patient (or group) is not present, such as during a case review conference.; (xsd)participant:Encounter.participant>*
[]< The appointment that scheduled this encounter.; (xsd)appointment:Appointment*>*
[]< Connection details of a virtual service (e.g. conference call). There are two types of virtual meetings that often exist:
* a persistent, virtual meeting room that can only be used for a single purpose at a time,
* and a dynamic virtual meeting room that is generated on demand for a specific purpose.
Implementers may consider using Location.virtualService for persistent meeting rooms.
If each participant would have a different meeting link, an extension using the VirtualServiceContactDetail can be applied to the Encounter.participant BackboneElement.; (xsd)virtualService:VirtualServiceDetail>*
< The actual start and end time of the encounter. If not (yet) known, the end of the Period may be omitted.; (xsd)actualPeriod:Period>?
< The planned start date/time (or admission date) of the encounter.; (xsd)plannedStartDate:dateTime>?
< The planned end date/time (or discharge date) of the encounter.; (xsd)plannedEndDate:dateTime>?
< Actual quantity of time the encounter lasted. This excludes the time during leaves of absence.
When missing it is the time in between the start and end values. If the precision on these values is low (e.g. to the day only) then this may be considered was an all day (or multi-day) encounter, unless the duration is included, where that amount of time occurred sometime during the interval.
May differ from the time in `Encounter.period` due to leave of absence(s).; (xsd)length:Duration>?
[]< The list of medical reasons that are expected to be addressed during the episode of care. The reason communicates what medical problem the patient has that should be addressed during the episode of care. This reason could be patient reported complaint, a clinical indication that was determined in a previous encounter or episode of care, or some planned care such as an immunization recommendation. In the case where you have a primary reason, but are expecting to also address other problems, you can list the primary reason with a use code of 'Chief Complaint', while the other problems being addressed would have a use code of 'Reason for Visit'.
Examples:
* pregnancy would use HealthcareService or a coding as the reason
* patient home monitoring could use Condition as the reason; (xsd)reason:Encounter.reason>*
[]< The list of diagnosis relevant to this encounter. Also note that for the purpose of billing, the diagnoses are recorded in the account where they can be ranked appropriately for how the invoicing/claiming documentation needs to be prepared.; (xsd)diagnosis:Encounter.diagnosis>*
[]< The set of accounts that may be used for billing for this Encounter. The billing system may choose to allocate billable items associated with the Encounter to different referenced Accounts based on internal business rules.; (xsd)account:Account*>*
[]< Diet preferences reported by the patient. For example, a patient may request both a dairy-free and nut-free diet preference (not mutually exclusive). Binding: encounter-diet (example, Medical, cultural or ethical food preferences to help with catering requirements.); (xsd)dietPreference:CodeableConcept>*
[]< Any special requests that have been made for this encounter, such as the provision of specific equipment or other things. Binding: encounter-special-arrangements (preferred, Special arrangements.); (xsd)specialArrangement:CodeableConcept>*
[]< Special courtesies that may be provided to the patient during the encounter (VIP, board member, professional courtesy). Although the specialCourtesy property can contain values like VIP, the purpose of this field is intended to be used for flagging additional `benefits` that might occur for the patient during the encounter.
It could include things like the patient is to have a private room, special room features, receive a friendly visit from hospital adminisitration, or should be briefed on treatment by senior staff during the stay.
It is not specifically intended to be used for securing the specific record - that is the purpose of the security meta tag, and where appropriate, both fields could be used. Binding: encounter-special-courtesy (preferred, Special courtesies.); (xsd)specialCourtesy:CodeableConcept>*
< Details about the stay during which a healthcare service is provided.
This does not describe the event of admitting the patient, but rather any information that is relevant from the time of admittance until the time of discharge. An Encounter may cover more than just the inpatient stay. Contexts such as outpatients, community clinics, and aged care facilities are also included.
The duration recorded in the period of this encounter covers the entire scope of this admission record.; (xsd)admission:Encounter.admission>?
[]< List of locations where the patient has been during this encounter. Virtual encounters can be recorded in the Encounter by specifying a location reference to a location of type "kind" such as "client's home" and an encounter.class = "virtual".; (xsd)location:Encounter.location>*🔗 Details about the stay during which a healthcare service is provided.
This does not describe the event of admitting the patient, but rather any information that is relevant from the time of admittance until the time of discharge. An Encounter may cover more than just the inpatient stay. Contexts such as outpatients, community clinics, and aged care facilities are also included.
The duration recorded in the period of this encounter covers the entire scope of this admission record.Encounter.admission(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Pre-admission identifier.; (xsd)preAdmissionIdentifier:Identifier>?
< The location/organization from which the patient came before admission.; (xsd)origin:(<Location>
|<Organization>)>?
< From where patient was admitted (physician referral, transfer). Binding: encounter-admit-source (preferred, From where the patient was admitted.); (xsd)admitSource:CodeableConcept>?
< Indicates that this encounter is directly related to a prior admission, often because the conditions addressed in the prior admission were not fully addressed. Binding: http://terminology.hl7.org/ValueSet/v2-0092 (example, The reason for re-admission of this admission encounter.); (xsd)reAdmission:CodeableConcept>?
< Location/organization to which the patient is discharged.; (xsd)destination:(<Location>
|<Organization>)>?
< Category or kind of location after discharge. Binding: encounter-discharge-disposition (example, Discharge Disposition.); (xsd)dischargeDisposition:CodeableConcept>?🔗 The list of diagnosis relevant to this encounter. Also note that for the purpose of billing, the diagnoses are recorded in the account where they can be ranked appropriately for how the invoicing/claiming documentation needs to be prepared.Encounter.diagnosis(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< The coded diagnosis or a reference to a Condition (with other resources referenced in the evidence.detail), the use property will indicate the purpose of this specific diagnosis. Binding: condition-code (example, ); (xsd)condition:Condition*>*
[]< Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …). Binding: encounter-diagnosis-use (preferred, The type of diagnosis this condition represents.); (xsd)use:CodeableConcept>*🔗 List of locations where the patient has been during this encounter. Virtual encounters can be recorded in the Encounter by specifying a location reference to a location of type "kind" such as "client's home" and an encounter.class = "virtual".Encounter.location(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The location where the encounter takes place.; (xsd)location:Location*>
< The status of the participants' presence at the specified location during the period specified. If the participant is no longer at the location, then the period will have an end date/time. When the patient is no longer active at a location, then the period end date is entered, and the status may be changed to completed. Binding: encounter-location-status (required, The status of the location.); (xsd)status:code>?
< This will be used to specify the required levels (bed/ward/room/etc.) desired to be recorded to simplify either messaging or query. This information is de-normalized from the Location resource to support the easier understanding of the encounter resource and processing in messaging or query.
There may be many levels in the hierachy, and this may only pic specific levels that are required for a specific usage scenario. Binding: location-form (example, Physical form of the location.); (xsd)form:CodeableConcept>?
< Time period during which the patient was present at the location.; (xsd)period:Period>?🔗 The list of people responsible for providing the service. Any Patient or Group present in the participation.actor must also be the subject, though the subject may be absent from the participation.actor for cases where the patient (or group) is not present, such as during a case review conference.Encounter.participant(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< Role of participant in encounter. The participant type indicates how an individual actor participates in an encounter. It includes non-practitioner participants, and for practitioners this is to describe the action type in the context of this encounter (e.g. Admitting Dr, Attending Dr, Translator, Consulting Dr). This is different to the practitioner roles which are functional roles, derived from terms of employment, education, licensing, etc. Binding: encounter-participant-type (extensible, Role of participant in encounter.); (xsd)type:CodeableConcept>*
< The period of time that the specified participant participated in the encounter. These can overlap or be sub-sets of the overall encounter's period.; (xsd)period:Period>?
< Person involved in the encounter, the patient/group is also included here to indicate that the patient was actually participating in the encounter. Not including the patient here covers use cases such as a case meeting between practitioners about a patient - non contact times. For planning purposes, Appointments may include a CareTeam participant to indicate that one specific person from the CareTeam will be assigned, but that assignment might not happen until the Encounter begins. Hence CareTeam is not included in Encounter.participant, as the specific individual should be assigned and represented as a Practitioner or other person resource.
Similarly, Location can be included in Appointment.participant to assist with planning. However, the patient location is tracked on the Encounter in the Encounter.location property to allow for additional metadata and history to be recorded.
The role of the participant can be used to declare what the actor will be doing in the scope of this encounter participation.
If the individual is not specified during planning, then it is expected that the individual will be filled in at a later stage prior to the encounter commencing.; (xsd)actor:(<Device>
|<Group>
|<HealthcareService>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>?🔗 The list of medical reasons that are expected to be addressed during the episode of care. The reason communicates what medical problem the patient has that should be addressed during the episode of care. This reason could be patient reported complaint, a clinical indication that was determined in a previous encounter or episode of care, or some planned care such as an immunization recommendation. In the case where you have a primary reason, but are expecting to also address other problems, you can list the primary reason with a use code of 'Chief Complaint', while the other problems being addressed would have a use code of 'Reason for Visit'.
Examples:
* pregnancy would use HealthcareService or a coding as the reason
* patient home monitoring could use Condition as the reasonEncounter.reason(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< What the reason value should be used as e.g. Chief Complaint, Health Concern, Health Maintenance (including screening). Binding: encounter-reason-use (example, ); (xsd)use:CodeableConcept>*
[]< Reason the encounter takes place, expressed as a code or a reference to another resource. For admissions, this can be used for a coded admission diagnosis. Binding: encounter-reason (preferred, Reason why the encounter takes place.); (xsd)value:(<Condition>
|<DiagnosticReport>
|<ImmunizationRecommendation>
|<Observation>
|<Procedure>)>*🔗 A record of significant events/milestones key data throughout the history of an Encounter, often tracked for specific purposes such as billing.EncounterHistory(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< The Encounter associated with this set of historic values. This is also used for associating a child's encounter back to the mother's encounter.
Refer to the Notes section in the Patient resource for further details.; (xsd)encounter:Encounter*>?
[]< Identifier(s) by which this encounter is known.; (xsd)identifier:Identifier>*
< planned | in-progress | on-hold | discharged | completed | cancelled | discontinued | entered-in-error | unknown. Note that internal business rules will determine the appropriate transitions that may occur between statuses (and also classes). Binding: encounter-status (required, Current state of the encounter.); (xsd)status:code>
< Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations. Binding: http://terminology.hl7.org/ValueSet/v3-ActEncounterCode (extensible, Classification of the encounter.); (xsd)class:CodeableConcept>
[]< Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation). Since there are many ways to further classify encounters, this element is 0..*. Binding: encounter-type (example, A specific code indicating type of service provided); (xsd)type:CodeableConcept>*
[]< Broad categorization of the service that is to be provided (e.g. cardiology). Binding: service-type (example, Broad categorization of the service that is to be provided.); (xsd)serviceType:HealthcareService*>*
< The patient or group related to this encounter. In some use-cases the patient MAY not be present, such as a case meeting about a patient between several practitioners or a careteam. While the encounter is always about the patient, the patient might not actually be known in all contexts of use, and there may be a group of patients that could be anonymous (such as in a group therapy for Alcoholics Anonymous - where the recording of the encounter could be used for billing on the number of people/staff and not important to the context of the specific patients) or alternately in veterinary care a herd of sheep receiving treatment (where the animals are not individually tracked).; (xsd)subject:(<Group>
|<Patient>)>?
< The subjectStatus value can be used to track the patient's status within the encounter. It details whether the patient has arrived or departed, has been triaged or is currently in a waiting status. Binding: encounter-subject-status (example, Current status of the subject within the encounter.); (xsd)subjectStatus:CodeableConcept>?
< The start and end time associated with this set of values associated with the encounter, may be different to the planned times for various reasons.; (xsd)actualPeriod:Period>?
< The planned start date/time (or admission date) of the encounter.; (xsd)plannedStartDate:dateTime>?
< The planned end date/time (or discharge date) of the encounter.; (xsd)plannedEndDate:dateTime>?
< Actual quantity of time the encounter lasted. This excludes the time during leaves of absence.
When missing it is the time in between the start and end values. If the precision on these values is low (e.g. to the day only) then this may be considered was an all day (or multi-day) encounter, unless the duration is included, where that amount of time occurred sometime during the interval.
May differ from the time in `Encounter.period` due to leave of absence(s).; (xsd)length:Duration>?
[]< The location of the patient at this point in the encounter, the multiple cardinality permits de-normalizing the levels of the location hierarchy, such as site/ward/room/bed. Virtual encounters can be recorded in the Encounter by specifying a location reference to a location of type "kind" such as "client's home" and an encounter.class = "virtual".; (xsd)location:EncounterHistory.location>*🔗 The location of the patient at this point in the encounter, the multiple cardinality permits de-normalizing the levels of the location hierarchy, such as site/ward/room/bed. Virtual encounters can be recorded in the Encounter by specifying a location reference to a location of type "kind" such as "client's home" and an encounter.class = "virtual".EncounterHistory.location(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The location where the encounter takes place.; (xsd)location:Location*>
< This will be used to specify the required levels (bed/ward/room/etc.) desired to be recorded to simplify either messaging or query. This information is de-normalized from the Location resource to support the easier understanding of the encounter resource and processing in messaging or query.
There may be many levels in the hierachy, and this may only pic specific levels that are required for a specific usage scenario. Binding: location-form (example, Physical form of the location.); (xsd)form:CodeableConcept>?🔗 The technical details of an endpoint that can be used for electronic services, such as for web services providing XDS.b, a REST endpoint for another FHIR server, or a s/Mime email address. This may include any security context information.Endpoint(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< Identifier for the organization that is used to identify the endpoint across multiple disparate systems.; (xsd)identifier:Identifier>*
< The endpoint status represents the general expected availability of an endpoint. This element is labeled as a modifier because the status contains codes that mark the endpoint as not currently valid. Temporary downtimes or other unexpected short-term changes in availability would not be represented in this property. Binding: endpoint-status (required, The status of the endpoint.); (xsd)status:code>
[]< A coded value that represents the technical details of the usage of this endpoint, such as what WSDLs should be used in what way. (e.g. XDS.b/DICOM/cds-hook). For additional connectivity details for the protocol, extensions will be used at this point, as in the XDS example. If there are multiple payload types or mimetypes they are all applicable for all connection types, and all have the same status. Binding: endpoint-connection-type (example, ); (xsd)connectionType:CodeableConcept>+
< A friendly name that this endpoint can be referred to with.; (xsd)name:string>?
< The description of the endpoint and what it is for (typically used as supplemental information in an endpoint directory describing its usage/purpose).; (xsd)description:string>?
[]< The type of environment(s) exposed at this endpoint (dev, prod, test, etc.). Binding: endpoint-environment (extensible, ); (xsd)environmentType:CodeableConcept>*
< The organization that manages this endpoint (even if technically another organization is hosting this in the cloud, it is the organization associated with the data). This property is not typically used when searching for Endpoint resources for usage. The typical usage is via the reference from an applicable Organization/Location/Practitioner resource, which is where the context is provided. Multiple Locations may reference a single endpoint, and don't have to be within the same organization resource, but most likely within the same organizational hierarchy.; (xsd)managingOrganization:Organization*>?
[]< Contact details for a human to contact about the endpoint. The primary use of this for system administrator troubleshooting.; (xsd)contact:ContactPoint>*
< The interval during which the endpoint is expected to be operational. Temporary downtimes or other short-term changes in availability would not be represented in this property.; (xsd)period:Period>?
[]< The set of payloads that are provided/available at this endpoint. Note that not all mimetypes or types will be listed under the one endpoint resource, there may be multiple instances that information for cases where other header data such as the endpoint address, active status/period etc. is different.; (xsd)payload:Endpoint.payload>*
< The uri that describes the actual end-point to connect to. For rest-hook, and websocket, the end-point must be an http: or https: URL; for email, a mailto: url, for sms, a tel: url, and for message the endpoint can be in any form of url the server understands (usually, http: or mllp:). The URI is allowed to be relative; in which case, it is relative to the server end-point (since there may be more than one, clients should avoid using relative URIs)
This address will be to the service base, without any parameters, or sub-services or resources tacked on.
E.g. for a WADO-RS endpoint, the url should be "https://pacs.hospital.org/wado-rs"
and not "https://pacs.hospital.org/wado-rs/studies/1.2.250.1.59.40211.12345678.678910/series/1.2.250.1.59.40211.789001276.14556172.67789/instances/...".; (xsd)address:url>
[]< Additional headers / information to send as part of the notification. Exactly what these mean depends on the channel type. The can convey additional information to the recipient and/or meet security requirements.; (xsd)header:string>*🔗 The set of payloads that are provided/available at this endpoint. Note that not all mimetypes or types will be listed under the one endpoint resource, there may be multiple instances that information for cases where other header data such as the endpoint address, active status/period etc. is different.Endpoint.payload(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< The payload type describes the acceptable content that can be communicated on the endpoint. The mimeType describes the serialization format of the data, where the payload.type indicates the specific document/schema that is being transferred; e.g. DischargeSummary or CarePlan. Binding: endpoint-payload-type (example, ); (xsd)type:CodeableConcept>*
[]< The mime type to send the payload in - e.g. application/fhir+xml, application/fhir+json. If the mime type is not specified, then the sender could send any content (including no content depending on the connectionType). Sending the payload has obvious security consequences. The server is responsible for ensuring that the content is appropriately secured. Binding: mimetypes (required, BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)); (xsd)mimeType:code>*🔗 This resource provides the insurance enrollment details to the insurer regarding a specified coverage.EnrollmentRequest(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< The Response business identifier.; (xsd)identifier:Identifier>*
< The status of the resource instance. This element is labeled as a modifier because the status contains codes that mark the request as not currently valid. Binding: fm-status (required, A code specifying the state of the resource instance.); (xsd)status:code>?
< The date when this resource was created.; (xsd)created:dateTime>?
< The Insurer who is target of the request.; (xsd)insurer:Organization*>?
< The practitioner who is responsible for the services rendered to the patient.; (xsd)provider:(<Organization>
|<Practitioner>
|<PractitionerRole>)>?
< Patient Resource.; (xsd)candidate:Patient*>?
< Reference to the program or plan identification, underwriter or payor.; (xsd)coverage:Coverage*>?🔗 This resource provides enrollment and plan details from the processing of an EnrollmentRequest resource.EnrollmentResponse(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< The Response business identifier.; (xsd)identifier:Identifier>*
< The status of the resource instance. This element is labeled as a modifier because the status contains codes that mark the response as not currently valid. Binding: fm-status (required, A code specifying the state of the resource instance.); (xsd)status:code>?
< Original request resource reference.; (xsd)request:EnrollmentRequest*>?
< Processing status: error, complete. Binding: enrollment-outcome (required, The outcome of the processing.); (xsd)outcome:code>?
< A description of the status of the adjudication.; (xsd)disposition:string>?
< The date when the enclosed suite of services were performed or completed.; (xsd)created:dateTime>?
< The Insurer who produced this adjudicated response.; (xsd)organization:Organization*>?
< The practitioner who is responsible for the services rendered to the patient.; (xsd)requestProvider:(<Organization>
|<Practitioner>
|<PractitionerRole>)>?🔗 An association between a patient and an organization / healthcare provider(s) during which time encounters may occur. The managing organization assumes a level of responsibility for the patient during this time.EpisodeOfCare(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< The EpisodeOfCare may be known by different identifiers for different contexts of use, such as when an external agency is tracking the Episode for funding purposes.; (xsd)identifier:Identifier>*
< planned | waitlist | active | onhold | finished | cancelled. This element is labeled as a modifier because the status contains codes that mark the episode as not currently valid. Binding: episode-of-care-status (required, The status of the episode of care.); (xsd)status:code>
[]< The history of statuses that the EpisodeOfCare has been through (without requiring processing the history of the resource).; (xsd)statusHistory:EpisodeOfCare.statusHistory>*
[]< A classification of the type of episode of care; e.g. specialist referral, disease management, type of funded care. The type can be very important in processing as this could be used in determining if the EpisodeOfCare is relevant to specific government reporting, or other types of classifications. Binding: episodeofcare-type (example, The type of the episode of care.); (xsd)type:CodeableConcept>*
[]< The list of medical reasons that are expected to be addressed during the episode of care. The reason communicates what medical problem the patient has that should be addressed during the episode of care. This reason could be patient reported complaint, a clinical indication that was determined in a previous encounter or episode of care, or some planned care such as an immunization recommendation. In the case where you have a primary reason, but are expecting to also address other problems, you can list the primary reason with a use code of 'Chief Complaint', while the other problems being addressed would have a use code of 'Reason for Visit'.
Examples:
* pregnancy would use HealthcareService or a coding as the reason
* patient home monitoring could use Condition as the reason; (xsd)reason:EpisodeOfCare.reason>*
[]< The list of medical conditions that were addressed during the episode of care. The diagnosis communicates what medical conditions were actually addressed during the episode of care. If a diagnosis was provided as a reason, and was treated during the episode of care, it may be listed in both EpisodeOfCare.reason and EpisodeOfCare.diagnosis.
Diagnoses related to billing can be documented on the Account resources which supports ranking for the purpose of reimbursement.; (xsd)diagnosis:EpisodeOfCare.diagnosis>*
< The patient who is the focus of this episode of care.; (xsd)patient:Patient*>
< The organization that has assumed the specific responsibilities for care coordination, care delivery, or other services for the specified duration. If multiple organizations are involved in care delivery, the care teams from those organizations would be represented in EpisodeOfCare.team, while the primary organization managing the care would be listed in EpisodeOfCare.managingOrganization. Other organizations may have their own EpisodeOfCare for tracking their activities.; (xsd)managingOrganization:Organization*>?
< The interval during which the managing organization assumes the defined responsibility.; (xsd)period:Period>?
[]< Referral Request(s) that are fulfilled by this EpisodeOfCare, incoming referrals.; (xsd)referralRequest:ServiceRequest*>*
< The practitioner that is the care manager/care coordinator for this patient.; (xsd)careManager:(<Practitioner>
|<PractitionerRole>)>?
[]< The list of practitioners that may be facilitating this episode of care for specific purposes.; (xsd)careTeam:CareTeam*>*
[]< The set of accounts that may be used for billing for this EpisodeOfCare. The billing system may choose to allocate billable items associated with the EpisodeOfCare to different referenced Accounts based on internal business rules.; (xsd)account:Account*>*🔗 The list of medical conditions that were addressed during the episode of care. The diagnosis communicates what medical conditions were actually addressed during the episode of care. If a diagnosis was provided as a reason, and was treated during the episode of care, it may be listed in both EpisodeOfCare.reason and EpisodeOfCare.diagnosis.
Diagnoses related to billing can be documented on the Account resources which supports ranking for the purpose of reimbursement.EpisodeOfCare.diagnosis(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< The medical condition that was addressed during the episode of care, expressed as a text, code or a reference to another resource. Binding: condition-code (example, ); (xsd)condition:Condition*>*
< Role that this diagnosis has within the episode of care (e.g. admission, billing, discharge …). Binding: encounter-diagnosis-use (preferred, The type of diagnosis this condition represents.); (xsd)use:CodeableConcept>?🔗 The list of medical reasons that are expected to be addressed during the episode of care. The reason communicates what medical problem the patient has that should be addressed during the episode of care. This reason could be patient reported complaint, a clinical indication that was determined in a previous encounter or episode of care, or some planned care such as an immunization recommendation. In the case where you have a primary reason, but are expecting to also address other problems, you can list the primary reason with a use code of 'Chief Complaint', while the other problems being addressed would have a use code of 'Reason for Visit'.
Examples:
* pregnancy would use HealthcareService or a coding as the reason
* patient home monitoring could use Condition as the reasonEpisodeOfCare.reason(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< What the reason value should be used as e.g. Chief Complaint, Health Concern, Health Maintenance (including screening). Binding: encounter-reason-use (example, ); (xsd)use:CodeableConcept>?
[]< The medical reason that is expected to be addressed during the episode of care, expressed as a text, code or a reference to another resource. Binding: encounter-reason (example, ); (xsd)value:(<Condition>
|<HealthcareService>
|<Observation>
|<Procedure>)>*🔗 The history of statuses that the EpisodeOfCare has been through (without requiring processing the history of the resource).EpisodeOfCare.statusHistory(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< planned | waitlist | active | onhold | finished | cancelled. Binding: episode-of-care-status (required, The status of the episode of care.); (xsd)status:code>
< The period during this EpisodeOfCare that the specific status applied.; (xsd)period:Period>🔗 The EventDefinition resource provides a reusable description of when a particular event can occur.EventDefinition(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< An absolute URI that is used to identify this event definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this event definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the event definition is stored on different servers. Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.
The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions).
In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.; (xsd)url:uri>?
[]< A formal identifier that is used to identify this event definition when it is represented in other formats, or referenced in a specification, model, design or an instance. Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this event definition outside of FHIR, where it is not possible to use the logical URI.; (xsd)identifier:Identifier>*
< The identifier that is used to identify this version of the event definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the event definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. There may be different event definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the event definition with the format [url]|[version]. The version SHOULD NOT contain a '#' - see [Business Version](resource.html#bv-format).; (xsd)version:string>?
< Indicates the mechanism used to compare versions to determine which is more current. If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined. Binding: version-algorithm (extensible, ); (xsd)versionAlgorithm:(<Coding>
|<string>)>?
< A natural language name identifying the event definition. This name should be usable as an identifier for the module by machine processing applications such as code generation. The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.; (xsd)name:string>?
< A short, descriptive, user-friendly title for the event definition. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.; (xsd)title:string>?
< An explanatory or alternate title for the event definition giving additional information about its content.; (xsd)subtitle:string>?
< The status of this event definition. Enables tracking the life-cycle of the content. Allows filtering of event definitions that are appropriate for use versus not.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization). Binding: publication-status (required, The lifecycle status of an artifact.); (xsd)status:code>
< A Boolean value to indicate that this event definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. Allows filtering of event definitions that are appropriate for use versus not.; (xsd)experimental:boolean>?
< A code or group definition that describes the intended subject of the event definition. Binding: participant-resource-types (extensible, The possible types of subjects for an event (E.g. Patient, Practitioner, Organization, Location, etc.).); (xsd)subject:(<CodeableConcept>
|<Group>)>?
< The date (and optionally time) when the event definition was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the event definition changes. The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the event definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)date:dateTime>?
< The name of the organization or individual responsible for the release and ongoing maintenance of the event definition. Usually an organization but may be an individual. The publisher (or steward) of the event definition is the organization or individual primarily responsible for the maintenance and upkeep of the event definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the event definition. This item SHOULD be populated unless the information is available from context.; (xsd)publisher:string>?
[]< Contact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)contact:ContactDetail>*
< A free text natural language description of the event definition from a consumer's perspective. This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the event definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the event definition is presumed to be the predominant language in the place the event definition was created).; (xsd)description:markdown>?
[]< The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate event definition instances. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.; (xsd)useContext:UsageContext>*
[]< A legal or geographic region in which the event definition is intended to be used. It may be possible for the event definition to be used in jurisdictions other than those for which it was originally designed or intended.
DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.) Binding: jurisdiction (extensible, Countries and regions within which this artifact is targeted for use.); (xsd)jurisdiction:CodeableConcept>*
< Explanation of why this event definition is needed and why it has been designed as it has. This element does not describe the usage of the event definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this event definition.; (xsd)purpose:markdown>?
< A detailed description of how the event definition is used from a clinical perspective.; (xsd)usage:markdown>?
< A copyright statement relating to the event definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the event definition. The short copyright declaration (e.g. (c) '2015+ xyz organization' should be sent in the copyrightLabel element.; (xsd)copyright:markdown>?
< A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved'). The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.; (xsd)copyrightLabel:string>?
< The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)approvalDate:date>?
< The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. If specified, this date follows the original approval date.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)lastReviewDate:date>?
< The period during which the event definition content was or is planned to be in active use. The effective period for an event definition determines when the content is applicable for usage and is independent of publication and review dates. For example, a definition intended to be used for the year 2016 might be published in 2015.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)effectivePeriod:Period>?
[]< Descriptive topics related to the module. Topics provide a high-level categorization of the module that can be useful for filtering and searching. DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'topic' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#topic and useContext.valueCodeableConcept indicating the topic) Binding: definition-topic (example, High-level categorization of the definition, used for searching, sorting, and filtering.); (xsd)topic:CodeableConcept>*
[]< An individiual or organization primarily involved in the creation and maintenance of the content.; (xsd)author:ContactDetail>*
[]< An individual or organization primarily responsible for internal coherence of the content.; (xsd)editor:ContactDetail>*
[]< An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the content. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)reviewer:ContactDetail>*
[]< An individual or organization asserted by the publisher to be responsible for officially endorsing the content for use in some setting. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)endorser:ContactDetail>*
[]< Related resources such as additional documentation, justification, or bibliographic references. Each related resource is either an attachment, or a reference to another resource, but not both.; (xsd)relatedArtifact:RelatedArtifact>*
[]< The trigger element defines when the event occurs. If more than one trigger condition is specified, the event fires whenever any one of the trigger conditions is met.; (xsd)trigger:TriggerDefinition>+🔗 The Evidence Resource provides a machine-interpretable expression of an evidence concept including the evidence variables (e.g., population, exposures/interventions, comparators, outcomes, measured variables, confounding variables), the statistics, and the certainty of this evidence.Evidence(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< An absolute URI that is used to identify this evidence when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this summary is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the summary is stored on different servers. In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found.; (xsd)url:uri>?
[]< A formal identifier that is used to identify this summary when it is represented in other formats, or referenced in a specification, model, design or an instance. Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this summary outside of FHIR, where it is not possible to use the logical URI.; (xsd)identifier:Identifier>*
< The identifier that is used to identify this version of the summary when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the summary author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions.; (xsd)version:string>?
< Indicates the mechanism used to compare versions to determine which is more current. If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 is newer, and a 0 if the version ordering can't successfully be determined. Binding: version-algorithm (extensible, ); (xsd)versionAlgorithm:(<Coding>
|<string>)>?
< A natural language name identifying the evidence. This name should be usable as an identifier for the module by machine processing applications such as code generation. The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.; (xsd)name:string>?
< A short, descriptive, user-friendly title for the summary.; (xsd)title:string>?
< Citation Resource or display of suggested citation for this evidence.; (xsd)citeAs:(<Citation>
|<markdown>)>?
< The status of this summary. Enables tracking the life-cycle of the content. Allows filtering of summarys s that are appropriate for use versus not.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization). Binding: publication-status (required, The lifecycle status of an artifact.); (xsd)status:code>
< A Boolean value to indicate that this resource is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.; (xsd)experimental:boolean>?
< The date (and optionally time) when the summary was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the summary changes. The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the summary. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)date:dateTime>?
< The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)approvalDate:date>?
< The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. If specified, this date follows the original approval date.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)lastReviewDate:date>?
< The name of the organization or individual responsible for the release and ongoing maintenance of the evidence. Usually an organization but may be an individual. The publisher (or steward) of the evidence is the organization or individual primarily responsible for the maintenance and upkeep of the evidence. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the evidence. This item SHOULD be populated unless the information is available from context.; (xsd)publisher:string>?
[]< Contact details to assist a user in finding and communicating with the publisher. Extensions to ContactDetail include: contactReference, contactAddress, and contributionTime (see [Clinical Reasoning Module](clinicalreasoning-module.html)).
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)contact:ContactDetail>*
[]< An individiual, organization, or device primarily involved in the creation and maintenance of the content. Extensions to ContactDetail include: contactReference, contactAddress, and contributionTime (see [Clinical Reasoning Module](clinicalreasoning-module.html)).; (xsd)author:ContactDetail>*
[]< An individiual, organization, or device primarily responsible for internal coherence of the content. Extensions to ContactDetail include: contactReference, contactAddress, and contributionTime (see [Clinical Reasoning Module](clinicalreasoning-module.html)).; (xsd)editor:ContactDetail>*
[]< An individiual, organization, or device primarily responsible for review of some aspect of the content. Extensions to ContactDetail include: contactReference, contactAddress, and contributionTime (see [Clinical Reasoning Module](clinicalreasoning-module.html)).
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)reviewer:ContactDetail>*
[]< An individiual, organization, or device responsible for officially endorsing the content for use in some setting. Extensions to ContactDetail include: contactReference, contactAddress, and contributionTime (see [Clinical Reasoning Module](clinicalreasoning-module.html)).
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)endorser:ContactDetail>*
[]< The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate evidence instances. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.; (xsd)useContext:UsageContext>*
< Explanation of why this Evidence is needed and why it has been designed as it has. This element does not describe the usage of the Evidence. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this Evidence.; (xsd)purpose:markdown>?
< A copyright statement relating to the Evidence and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the Evidence. The short copyright declaration (e.g. (c) '2015+ xyz organization' should be sent in the copyrightLabel element.; (xsd)copyright:markdown>?
< A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved'). The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.; (xsd)copyrightLabel:string>?
[]< Link or citation to artifact associated with the summary.; (xsd)relatedArtifact:RelatedArtifact>*
< A free text natural language description of the evidence from a consumer's perspective. This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the evidence as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the evidence is presumed to be the predominant language in the place the evidence was created).; (xsd)description:markdown>?
< Declarative description of the Evidence.; (xsd)assertion:markdown>?
[]< Footnotes and/or explanatory notes.; (xsd)note:Annotation>*
[]< Evidence variable such as population, exposure, or outcome.; (xsd)variableDefinition:Evidence.variableDefinition>+
< The method to combine studies. Binding: http://terminology.hl7.org/ValueSet/synthesis-type (extensible, Types of combining results from a body of evidence (e.g. summary data meta-analysis).); (xsd)synthesisType:CodeableConcept>?
[]< The design of the study that produced this evidence. The design is described with any number of study design characteristics. Binding: study-design (extensible, This is a set of terms for study design characteristics.); (xsd)studyDesign:CodeableConcept>*
[]< Values and parameters for a single statistic.; (xsd)statistic:Evidence.statistic>*
[]< Assessment of certainty, confidence in the estimates, or quality of the evidence.; (xsd)certainty:Evidence.certainty>*🔗 Assessment of certainty, confidence in the estimates, or quality of the evidence.Evidence.certainty(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Textual description of certainty.; (xsd)description:markdown>?
[]< Footnotes and/or explanatory notes.; (xsd)note:Annotation>*
< Aspect of certainty being rated. Binding: certainty-type (extensible, The aspect of quality, confidence, or certainty.); (xsd)type:CodeableConcept>?
< Assessment or judgement of the aspect. Binding: certainty-rating (extensible, The assessment of quality, confidence, or certainty.); (xsd)rating:CodeableConcept>?
< Individual or group who did the rating.; (xsd)rater:string>?
[]< A domain or subdomain of certainty.; (xsd)subcomponent:Evidence.certainty>*🔗 Values and parameters for a single statistic.Evidence.statistic(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A description of the content value of the statistic.; (xsd)description:markdown>?
[]< Footnotes and/or explanatory notes.; (xsd)note:Annotation>*
< Type of statistic, e.g., relative risk. Binding: statistic-type (extensible, ); (xsd)statisticType:CodeableConcept>?
< When the measured variable is handled categorically, the category element is used to define which category the statistic is reporting. Simple strings can be used for descriptive purposes. Exact matching to EvidenceVariable.category.name for the Evidence.variableDefinition[variableRole=measuredVariable].observed=Reference(EvidenceVariable) could facilitate validation within datasets.; (xsd)category:CodeableConcept>?
< Statistic value.; (xsd)quantity:Quantity>?
< The number of events associated with the statistic, where the unit of analysis is different from numberAffected, sampleSize.knownDataCount and sampleSize.numberOfParticipants. When the number of events is the statistic, use Evidence.statistic.quantity and set Evidence.statistic.type.coding.code=C25463 and Evidence.statistic.type.coding.display=Count. When the statistic is an Event Rate (where individual participants may have 2 or more events), use Evidence.statistic.numberOfEvents to record the total number of events rather than the number of participants with events.; (xsd)numberOfEvents:unsignedInt>?
< The number of participants affected where the unit of analysis is the same as sampleSize.knownDataCount and sampleSize.numberOfParticipants. When the number affected is the statistic, use Evidence.statistic.quantity and set Evidence.statistic.type.coding.code=C25463 and Evidence.statistic.type.coding.display=Count. When the statistic is a Proportion, use Evidence.statistic.numberAffected and enter an integer as the value. When the statistic is an Event Rate (where individual participants may have 2 or more events), use Evidence.statistic.numberAffected to record the number of participants with events rather than the total number of events.; (xsd)numberAffected:unsignedInt>?
< Number of samples in the statistic.; (xsd)sampleSize:Evidence.statistic.sampleSize>?
[]< A statistical attribute of the statistic such as a measure of heterogeneity.; (xsd)attributeEstimate:Evidence.statistic.attributeEstimate>*
[]< A component of the method to generate the statistic.; (xsd)modelCharacteristic:Evidence.statistic.modelCharacteristic>*🔗 A statistical attribute of the statistic such as a measure of heterogeneity.Evidence.statistic.attributeEstimate(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Human-readable summary of the estimate.; (xsd)description:markdown>?
[]< Footnote or explanatory note about the estimate.; (xsd)note:Annotation>*
< The type of attribute estimate, e.g., confidence interval or p value. Binding: attribute-estimate-type (extensible, ); (xsd)type:CodeableConcept>?
< The singular quantity of the attribute estimate, for attribute estimates represented as single values; also used to report unit of measure. Often the p value; (xsd)quantity:Quantity>?
< Use 95 for a 95% confidence interval.; (xsd)level:decimal>?
< Lower bound of confidence interval.; (xsd)range:Range>?
[]< A nested attribute estimate; which is the attribute estimate of an attribute estimate. A nested attribute estimate; which is the attribute estimate of an attribute estimate; (xsd)attributeEstimate:Evidence.statistic.attributeEstimate>*🔗 A component of the method to generate the statistic.Evidence.statistic.modelCharacteristic(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Description of a component of the method to generate the statistic. Binding: statistic-model-code (extensible, ); (xsd)code:CodeableConcept>
< Further specification of the quantified value of the component of the method to generate the statistic.; (xsd)value:SimpleQuantity>?
[]< A variable adjusted for in the adjusted analysis.; (xsd)variable:Evidence.statistic.modelCharacteristic.variable>*
[]< An attribute of the statistic used as a model characteristic.; (xsd)attributeEstimate:Evidence.statistic.attributeEstimate>*🔗 A variable adjusted for in the adjusted analysis.Evidence.statistic.modelCharacteristic.variable(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Description of the variable.; (xsd)variableDefinition:(<EvidenceVariable>
|<Group>)>
< How the variable is classified for use in adjusted analysis. Binding: variable-handling (required, ); (xsd)handling:code>?
[]< Description for grouping of ordinal or polychotomous variables.; (xsd)valueCategory:CodeableConcept>*
[]< Discrete value for grouping of ordinal or polychotomous variables.; (xsd)valueQuantity:Quantity>*
[]< Range of values for grouping of ordinal or polychotomous variables.; (xsd)valueRange:Range>*🔗 Number of samples in the statistic.Evidence.statistic.sampleSize(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Human-readable summary of population sample size.; (xsd)description:markdown>?
[]< Footnote or explanatory note about the sample size.; (xsd)note:Annotation>*
< Number of participants in the population.; (xsd)numberOfStudies:unsignedInt>?
< A human-readable string to clarify or explain concepts about the sample size.; (xsd)numberOfParticipants:unsignedInt>?
< Number of participants with known results for measured variables.; (xsd)knownDataCount:unsignedInt>?🔗 Evidence variable such as population, exposure, or outcome.Evidence.variableDefinition(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A text description or summary of the variable.; (xsd)description:markdown>?
[]< Footnotes and/or explanatory notes.; (xsd)note:Annotation>*
< population | subpopulation | exposure | referenceExposure | measuredVariable | confounder. Binding: variable-role (extensible, The role that the assertion variable plays.); (xsd)variableRole:CodeableConcept>
< Definition of the actual variable related to the statistic(s).; (xsd)observed:(<EvidenceVariable>
|<Group>)>?
< Definition of the intended variable related to the Evidence.; (xsd)intended:(<EvidenceVariable>
|<Group>)>?
< Indication of quality of match between intended variable to actual variable. Binding: http://terminology.hl7.org/ValueSet/directness (extensible, The quality of how direct the match is.); (xsd)directnessMatch:CodeableConcept>?🔗 The EvidenceReport Resource is a specialized container for a collection of resources and codeable concepts, adapted to support compositions of Evidence, EvidenceVariable, and Citation resources and related concepts.EvidenceReport(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< An absolute URI that is used to identify this EvidenceReport when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this summary is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the summary is stored on different servers. Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.; (xsd)url:uri>?
< The status of this summary. Enables tracking the life-cycle of the content. Allows filtering of summaries that are appropriate for use versus not.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization). Binding: publication-status (required, The lifecycle status of an artifact.); (xsd)status:code>
[]< The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate evidence report instances. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.; (xsd)useContext:UsageContext>*
[]< A formal identifier that is used to identify this EvidenceReport when it is represented in other formats, or referenced in a specification, model, design or an instance. This element will contain unique identifiers that support de-duplication of EvidenceReports. This identifier can be valid for only one EvidenceReport resource.; (xsd)identifier:Identifier>*
[]< A formal identifier that is used to identify things closely related to this EvidenceReport. May include trial registry identifiers, e.g. NCT04372602 from clinicaltrials.gov. This identifier can be valid for multiple EvidenceReport resources.; (xsd)relatedIdentifier:Identifier>*
< Citation Resource or display of suggested citation for this report. used for reports for which external citation is expected, such as use in support of scholarly publications.; (xsd)citeAs:(<Citation>
|<markdown>)>?
< Specifies the kind of report, such as grouping of classifiers, search results, or human-compiled expression. Binding: evidence-report-type (example, The kind of report, such as grouping of classifiers, search results, or human-compiled expression.); (xsd)type:CodeableConcept>?
[]< Used for footnotes and annotations.; (xsd)note:Annotation>*
[]< Link, description or reference to artifact associated with the report.; (xsd)relatedArtifact:RelatedArtifact>*
< Specifies the subject or focus of the report. Answers "What is this report about?". May be used as an expression for search queries and search results; (xsd)subject:EvidenceReport.subject>
< The name of the organization or individual responsible for the release and ongoing maintenance of the evidence report. Usually an organization but may be an individual. The publisher (or steward) of the evidence report is the organization or individual primarily responsible for the maintenance and upkeep of the evidence report. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the evidence report. This item SHOULD be populated unless the information is available from context.; (xsd)publisher:string>?
[]< Contact details to assist a user in finding and communicating with the publisher. Extensions to ContactDetail include: contactReference, contactAddress, and contributionTime (see [Clinical Reasoning Module](clinicalreasoning-module.html)).
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)contact:ContactDetail>*
[]< An individiual, organization, or device primarily involved in the creation and maintenance of the content. Extensions to ContactDetail include: contactReference, contactAddress, and contributionTime (see [Clinical Reasoning Module](clinicalreasoning-module.html)).; (xsd)author:ContactDetail>*
[]< An individiual, organization, or device primarily responsible for internal coherence of the content. Extensions to ContactDetail include: contactReference, contactAddress, and contributionTime (see [Clinical Reasoning Module](clinicalreasoning-module.html)).; (xsd)editor:ContactDetail>*
[]< An individiual, organization, or device primarily responsible for review of some aspect of the content. Extensions to ContactDetail include: contactReference, contactAddress, and contributionTime (see [Clinical Reasoning Module](clinicalreasoning-module.html)).
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)reviewer:ContactDetail>*
[]< An individiual, organization, or device responsible for officially endorsing the content for use in some setting. Extensions to ContactDetail include: contactReference, contactAddress, and contributionTime (see [Clinical Reasoning Module](clinicalreasoning-module.html)).
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)endorser:ContactDetail>*
[]< Relationships that this composition has with other compositions or documents that already exist. A document is a version specific composition.; (xsd)relatesTo:EvidenceReport.relatesTo>*
[]< The root of the sections that make up the composition.; (xsd)section:EvidenceReport.section>*🔗 Relationships that this composition has with other compositions or documents that already exist. A document is a version specific composition.EvidenceReport.relatesTo(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The type of relationship that this composition has with anther composition or document. If this document appends another document, then the document cannot be fully understood without also accessing the referenced document. Binding: report-relation-type (required, The type of relationship between reports.); (xsd)code>
< The target composition/document of this relationship.; (xsd)target:EvidenceReport.relatesTo.target>🔗 The target composition/document of this relationship.EvidenceReport.relatesTo.target(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Target of the relationship URL.; (xsd)url:uri>?
< Target of the relationship Identifier.; (xsd)identifier:Identifier>?
< Target of the relationship Display.; (xsd)display:markdown>?
< Target of the relationship Resource reference.; (xsd)resource:Resource*>?🔗 The root of the sections that make up the composition.EvidenceReport.section(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents. The title identifies the section for a human reader. The title must be consistent with the narrative of the resource that is the target of the section.content reference. Generally, sections SHOULD have titles, but in some documents, it is unnecessary or inappropriate. Typically, this is where a section has subsections that have their own adequately distinguishing title, or documents that only have a single section.; (xsd)title:string>?
< A code identifying the kind of content contained within the section. This should be consistent with the section title. The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document.
If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code. Binding: evidence-report-section (extensible, Evidence Report Section Type.); (xsd)focus:CodeableConcept>?
< A definitional Resource identifying the kind of content contained within the section. This should be consistent with the section title.; (xsd)focusReference:Resource*>?
[]< Identifies who is responsible for the information in this section, not necessarily who typed it in.; (xsd)author:(<Device>
|<Group>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>*
< A human-readable narrative that contains the attested content of the section, used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is peferred to contain sufficient detail to make it acceptable for a human to just read the narrative. Document profiles may define what content should be represented in the narrative.; (xsd)text:Narrative>?
< How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted. This element is labeled as a modifier because a change list must not be misunderstood as a complete list. Binding: list-mode (required, The processing mode that applies to this section.); (xsd)mode:code>?
< Specifies the order applied to the items in the section entries. Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order. Binding: list-order (preferred, What order applies to the items in the entry.); (xsd)orderedBy:CodeableConcept>?
[]< Specifies any type of classification of the evidence report. Binding: evidence-classifier-code (extensible, Commonly used classifiers for evidence sets.); (xsd)entryClassifier:CodeableConcept>*
[]< A reference to the actual resource from which the narrative in the section is derived. If there are no entries in the list, an emptyReason SHOULD be provided.; (xsd)entryReference:Resource*>*
[]< Quantity as content.; (xsd)entryQuantity:Quantity>*
< If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason. The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases. Binding: list-empty-reason (preferred, If a section is empty, why it is empty.); (xsd)emptyReason:CodeableConcept>?
[]< A nested sub-section within this section. Nested sections are primarily used to help human readers navigate to particular portions of the document.; (xsd)section:EvidenceReport.section>*🔗 Specifies the subject or focus of the report. Answers "What is this report about?". May be used as an expression for search queries and search resultsEvidenceReport.subject(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< Characteristic.; (xsd)characteristic:EvidenceReport.subject.characteristic>*
[]< Used for general notes and annotations not coded elsewhere.; (xsd)note:Annotation>*🔗 Characteristic.EvidenceReport.subject.characteristic(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Characteristic code. Example 1 is a Citation. Example 2 is a type of outcome. Example 3 is a specific outcome. Binding: focus-characteristic-code (extensible, Evidence focus characteristic code.); (xsd)code:CodeableConcept>
(<valueBoolean:boolean>
|<valueCodeableConcept:CodeableConcept>
|<valueQuantity:Quantity>
|<valueRange:Range>
|<valueResource:Resource>)
< Is used to express not the characteristic.; (xsd)exclude:boolean>?
< Timeframe for the characteristic.; (xsd)period:Period>?🔗 The EvidenceVariable resource describes an element that knowledge (Evidence) is about. The EvidenceVariable may be an exposure variable (intervention, condition, or state), a measured variable (outcome or observed parameter), or other variable (such as confounding factor).EvidenceVariable(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< An absolute URI that is used to identify this evidence variable when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this evidence variable is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the evidence variable is stored on different servers. In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found.; (xsd)url:uri>?
[]< A formal identifier that is used to identify this evidence variable when it is represented in other formats, or referenced in a specification, model, design or an instance. Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this evidence variable outside of FHIR, where it is not possible to use the logical URI.; (xsd)identifier:Identifier>*
< The identifier that is used to identify this version of the evidence variable when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the evidence variable author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts. There may be different evidence variable instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the evidence variable with the format [url]|[version]. The version SHOULD NOT contain a '#' - see [Business Version](resource.html#bv-format).; (xsd)version:string>?
< Indicates the mechanism used to compare versions to determine which is more current. If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 is newer, and a 0 if the version ordering can't successfully be determined. Binding: version-algorithm (extensible, ); (xsd)versionAlgorithm:(<Coding>
|<string>)>?
< A natural language name identifying the evidence variable. This name should be usable as an identifier for the module by machine processing applications such as code generation. The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.; (xsd)name:string>?
< A short, descriptive, user-friendly title for the evidence variable. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.; (xsd)title:string>?
< The short title provides an alternate title for use in informal descriptive contexts where the full, formal title is not necessary.; (xsd)shortTitle:string>?
< The status of this evidence variable. Enables tracking the life-cycle of the content. Allows filtering of evidence variables that are appropriate for use versus not.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization). Binding: publication-status (required, The lifecycle status of an artifact.); (xsd)status:code>
< A Boolean value to indicate that this resource is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.; (xsd)experimental:boolean>?
< The date (and optionally time) when the evidence variable was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the evidence variable changes. The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the evidence variable. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)date:dateTime>?
< The name of the organization or individual responsible for the release and ongoing maintenance of the evidence variable. Usually an organization but may be an individual. The publisher (or steward) of the evidence variable is the organization or individual primarily responsible for the maintenance and upkeep of the evidence variable. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the evidence variable. This item SHOULD be populated unless the information is available from context.; (xsd)publisher:string>?
[]< Contact details to assist a user in finding and communicating with the publisher. Extensions to ContactDetail include: contactReference, contactAddress, and contributionTime (see [Clinical Reasoning Module](clinicalreasoning-module.html)).
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)contact:ContactDetail>*
< A free text natural language description of the evidence variable from a consumer's perspective. This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the evidence variable as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the evidence variable is presumed to be the predominant language in the place the evidence variable was created).; (xsd)description:markdown>?
[]< A human-readable string to clarify or explain concepts about the resource.; (xsd)note:Annotation>*
[]< The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate evidence variable instances. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.; (xsd)useContext:UsageContext>*
< Explanation of why this EvidenceVariable is needed and why it has been designed as it has. This element does not describe the usage of the EvidenceVariable. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this EvidenceVariable.; (xsd)purpose:markdown>?
< A copyright statement relating to the resource and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the resource.; (xsd)copyright:markdown>?
< A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved'). The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.; (xsd)copyrightLabel:string>?
< The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)approvalDate:date>?
< The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. If specified, this date follows the original approval date.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)lastReviewDate:date>?
< The period during which the resource content was or is planned to be in active use. The effective period for an EvidenceVariable determines when the content is applicable for usage and is independent of publication and review dates. For example, a variable intended to be used for the year 2016 might be published in 2015.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)effectivePeriod:Period>?
[]< An individiual or organization primarily involved in the creation and maintenance of the content. Extensions to ContactDetail include: contactReference, contactAddress, and contributionTime (see [Clinical Reasoning Module](clinicalreasoning-module.html)).; (xsd)author:ContactDetail>*
[]< An individual or organization primarily responsible for internal coherence of the content. Extensions to ContactDetail include: contactReference, contactAddress, and contributionTime (see [Clinical Reasoning Module](clinicalreasoning-module.html)).; (xsd)editor:ContactDetail>*
[]< An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the content. Extensions to ContactDetail include: contactReference, contactAddress, and contributionTime (see [Clinical Reasoning Module](clinicalreasoning-module.html)).
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)reviewer:ContactDetail>*
[]< An individual or organization asserted by the publisher to be responsible for officially endorsing the content for use in some setting. Extensions to ContactDetail include: contactReference, contactAddress, and contributionTime (see [Clinical Reasoning Module](clinicalreasoning-module.html)).
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)endorser:ContactDetail>*
[]< Related artifacts such as additional documentation, justification, or bibliographic references. Each related artifact is either an attachment, or a reference to another resource, but not both.; (xsd)relatedArtifact:RelatedArtifact>*
< True if the actual variable measured, false if a conceptual representation of the intended variable.; (xsd)actual:boolean>?
[]< A defining factor of the EvidenceVariable. Multiple characteristics are applied with "and" semantics. Characteristics can be defined flexibly to accommodate different use cases for membership criteria, ranging from simple codes, all the way to using an expression language to express the criteria.; (xsd)characteristic:EvidenceVariable.characteristic>*
< The method of handling in statistical analysis. Binding: variable-handling (required, ); (xsd)handling:code>?
[]< A grouping for ordinal or polychotomous variables.; (xsd)category:EvidenceVariable.category>*🔗 A grouping for ordinal or polychotomous variables.EvidenceVariable.category(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Description of the grouping.; (xsd)name:string>?
(<valueCodeableConcept:CodeableConcept>
|<valueQuantity:Quantity>
|<valueRange:Range>)?🔗 A defining factor of the EvidenceVariable. Multiple characteristics are applied with "and" semantics. Characteristics can be defined flexibly to accommodate different use cases for membership criteria, ranging from simple codes, all the way to using an expression language to express the criteria.EvidenceVariable.characteristic(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Label used for when a characteristic refers to another characteristic.; (xsd)linkId:id>?
< A short, natural language description of the characteristic that could be used to communicate the criteria to an end-user.; (xsd)description:markdown>?
[]< A human-readable string to clarify or explain concepts about the characteristic.; (xsd)note:Annotation>*
< When true, this characteristic is an exclusion criterion. In other words, not matching this characteristic definition is equivalent to meeting this criterion.; (xsd)exclude:boolean>?
< Defines the characteristic using a Reference.; (xsd)definitionReference:(<Evidence>
|<EvidenceVariable>
|<Group>)>?
< Defines the characteristic using Canonical.; (xsd)definitionCanonical:(<Evidence>
|<EvidenceVariable>)>?
< Defines the characteristic using CodeableConcept.; (xsd)definitionCodeableConcept:CodeableConcept>?
< Defines the characteristic using Expression. When another element provides a definition of the characteristic, the definitionExpression content SHALL match the definition (only adding technical concepts necessary for implementation) without changing the meaning.; (xsd)definitionExpression:Expression>?
< Defines the characteristic using id.; (xsd)definitionId:id>?
< Defines the characteristic using both a type and value[x] elements.; (xsd)definitionByTypeAndValue:EvidenceVariable.characteristic.definitionByTypeAndValue>?
< Defines the characteristic as a combination of two or more characteristics.; (xsd)definitionByCombination:EvidenceVariable.characteristic.definitionByCombination>?
< Number of occurrences meeting the characteristic.; (xsd)instances:(<Quantity>
|<Range>)>?
< Length of time in which the characteristic is met.; (xsd)duration:(<Quantity>
|<Range>)>?
[]< Timing in which the characteristic is determined.; (xsd)timeFromEvent:EvidenceVariable.characteristic.timeFromEvent>*🔗 Defines the characteristic as a combination of two or more characteristics.EvidenceVariable.characteristic.definitionByCombination(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Used to specify if two or more characteristics are combined with OR or AND. Binding: characteristic-combination (required, ); (xsd)code>
< Provides the value of "n" when "at-least" or "at-most" codes are used.; (xsd)threshold:positiveInt>?
[]< A defining factor of the characteristic.; (xsd)characteristic:EvidenceVariable.characteristic>+🔗 Defines the characteristic using both a type and value[x] elements.EvidenceVariable.characteristic.definitionByTypeAndValue(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Used to express the type of characteristic. Binding: http://terminology.hl7.org/ValueSet/usage-context-type (example, ); (xsd)type:CodeableConcept>
[]< Method for how the characteristic value was determined. Binding: definition-method (example, ); (xsd)method:CodeableConcept>*
< Device used for determining characteristic.; (xsd)device:(<Device>
|<DeviceMetric>)>?
(<valueBoolean:boolean>
|<valueCodeableConcept:CodeableConcept>
|<valueId:id>
|<valueQuantity:Quantity>
|<valueRange:Range>
|<valueResource:Resource>)
< Defines the reference point for comparison when valueQuantity or valueRange is not compared to zero. Binding: characteristic-offset (example, ); (xsd)offset:CodeableConcept>?🔗 Timing in which the characteristic is determined.EvidenceVariable.characteristic.timeFromEvent(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Human readable description.; (xsd)description:markdown>?
[]< A human-readable string to clarify or explain concepts about the timeFromEvent.; (xsd)note:Annotation>*
< The event used as a base point (reference point) in time. Binding: evidence-variable-event (example, ); (xsd)event:(<CodeableConcept>
|<dateTime>
|<id>
|<Resource>)>?
< Used to express the observation at a defined amount of time before or after the event.; (xsd)quantity:Quantity>?
< Used to express the observation within a period before and/or after the event.; (xsd)range:Range>?🔗 Example of workflow instance.ExampleScenario(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< An absolute URI that is used to identify this example scenario when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this example scenario is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the example scenario is stored on different servers. Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.
The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions).
In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.; (xsd)url:uri>?
[]< A formal identifier that is used to identify this example scenario when it is represented in other formats, or referenced in a specification, model, design or an instance. Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this example scenario outside of FHIR, where it is not possible to use the logical URI.; (xsd)identifier:Identifier>*
< The identifier that is used to identify this version of the example scenario when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the example scenario author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. There may be different example scenario instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the example scenario with the format [url]|[version]. The version SHOULD NOT contain a '#' - see [Business Version](resource.html#bv-format).; (xsd)version:string>?
< Indicates the mechanism used to compare versions to determine which is more current. If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined. Binding: version-algorithm (extensible, ); (xsd)versionAlgorithm:(<Coding>
|<string>)>?
< Temporarily retained for tooling purposes. Not needed as code will never be generated from one of these; (xsd)name:string>?
< A short, descriptive, user-friendly title for the ExampleScenario. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.; (xsd)title:string>?
< The status of this example scenario. Enables tracking the life-cycle of the content. Allows filtering of example scenarios that are appropriate for use versus not.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization). Binding: publication-status (required, The lifecycle status of an artifact.); (xsd)status:code>
< A Boolean value to indicate that this example scenario is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. Allows filtering of example scenarios that are appropriate for use versus not.; (xsd)experimental:boolean>?
< The date (and optionally time) when the example scenario was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the example scenario changes. (e.g. the 'content logical definition'). The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the example scenario. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)date:dateTime>?
< The name of the organization or individual responsible for the release and ongoing maintenance of the example scenario. Usually an organization but may be an individual. The publisher (or steward) of the example scenario is the organization or individual primarily responsible for the maintenance and upkeep of the example scenario. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the example scenario. This item SHOULD be populated unless the information is available from context.; (xsd)publisher:string>?
[]< Contact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)contact:ContactDetail>*
< A free text natural language description of the ExampleScenario from a consumer's perspective. This description can be used to capture details such as comments about misuse. It is not a rendering of the ExampleScenario as conveyed in the 'text' field of the resource itself.; (xsd)description:markdown>?
[]< The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate example scenario instances. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.; (xsd)useContext:UsageContext>*
[]< A legal or geographic region in which the example scenario is intended to be used. It may be possible for the example scenario to be used in jurisdictions other than those for which it was originally designed or intended.
DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.) Binding: jurisdiction (extensible, Countries and regions within which this artifact is targeted for use.); (xsd)jurisdiction:CodeableConcept>*
< What the example scenario resource is created for. This should not be used to show the business purpose of the scenario itself, but the purpose of documenting a scenario. This element does not describe the usage of the example scenario. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this example scenario.; (xsd)purpose:markdown>?
< A copyright statement relating to the example scenario and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the example scenario. ...; (xsd)copyright:markdown>?
< A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved'). The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.; (xsd)copyrightLabel:string>?
[]< A system or person who shares or receives an instance within the scenario.; (xsd)actor:ExampleScenario.actor>*
[]< A single data collection that is shared as part of the scenario.; (xsd)instance:ExampleScenario.instance>*
[]< A group of operations that represents a significant step within a scenario. Some scenarios might describe only one process.; (xsd)process:ExampleScenario.process>*🔗 A system or person who shares or receives an instance within the scenario.ExampleScenario.actor(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A unique string within the scenario that is used to reference the actor.; (xsd)key:string>
< The category of actor - person or system. Binding: examplescenario-actor-type (required, The type of actor - system or human.); (xsd)type:code>
< The human-readable name for the actor used when rendering the scenario.; (xsd)title:string>
< An explanation of who/what the actor is and its role in the scenario.; (xsd)description:markdown>?🔗 A single data collection that is shared as part of the scenario.ExampleScenario.instance(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A unique string within the scenario that is used to reference the instance.; (xsd)key:string>
< A code indicating the kind of data structure (FHIR resource or some other standard) this is an instance of. Binding: examplescenario-instance-type (extensible, The structure that defines the instance); (xsd)structureType:Coding>
< Conveys the version of the data structure instantiated. I.e. what release of FHIR, X12, OpenEHR, etc. is instance compliant with.; (xsd)structureVersion:string>?
< Refers to a profile, template or other ruleset the instance adheres to.; (xsd)structureProfile:(<Resource>
|<uri>)>?
< A short descriptive label the instance to be used in tables or diagrams.; (xsd)title:string>
< An explanation of what the instance contains and what it's for.; (xsd)description:markdown>?
< Points to an instance (typically an example) that shows the data that would corespond to this instance. If not conveying FHIR data or not using the same version of FHIR as this ExampleScenario instance, the reference must be to a Binary.; (xsd)content:Resource*>?
[]< Represents the instance as it was at a specific time-point. Not used if an instance doesn't change; (xsd)version:ExampleScenario.instance.version>*
[]< References to other instances that can be found within this instance (e.g. the observations contained in a bundle).; (xsd)containedInstance:ExampleScenario.instance.containedInstance>*🔗 References to other instances that can be found within this instance (e.g. the observations contained in a bundle).ExampleScenario.instance.containedInstance(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A reference to the key of an instance found within this one.; (xsd)instanceReference:string>
< A reference to the key of a specific version of an instance in this instance. Required if the referenced instance has versions; (xsd)versionReference:string>?🔗 Represents the instance as it was at a specific time-point. Not used if an instance doesn't changeExampleScenario.instance.version(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A unique string within the instance that is used to reference the version of the instance.; (xsd)key:string>
< A short descriptive label the version to be used in tables or diagrams.; (xsd)title:string>
< An explanation of what this specific version of the instance contains and represents.; (xsd)description:markdown>?
< Points to an instance (typically an example) that shows the data that would flow at this point in the scenario. If not conveying FHIR data or not using the same version of FHIR as this ExampleScenario instance, the reference must be to a Binary.; (xsd)content:Resource*>?🔗 A group of operations that represents a significant step within a scenario. Some scenarios might describe only one process.ExampleScenario.process(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A short descriptive label the process to be used in tables or diagrams.; (xsd)title:string>
< An explanation of what the process represents and what it does.; (xsd)description:markdown>?
< Description of the initial state of the actors, environment and data before the process starts.; (xsd)preConditions:markdown>?
< Description of the final state of the actors, environment and data after the process has been successfully completed. Alternate steps might not result in all post conditions holding; (xsd)postConditions:markdown>?
[]< A significant action that occurs as part of the process.; (xsd)step:ExampleScenario.process.step>*🔗 A significant action that occurs as part of the process.ExampleScenario.process.step(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The sequential number of the step, e.g. 1.2.5. If step numbers are simultaneous, they will be the same. Numbers don't have to be numeric. E.g. '2c)' is a valid step number; (xsd)number:string>?
< Indicates that the step is a complex sub-process with its own steps.; (xsd)process:ExampleScenario.process>?
< Indicates that the step is defined by a seaparate scenario instance.; (xsd)workflow:ExampleScenario*>?
< The step represents a single operation invoked on receiver by sender.; (xsd)operation:ExampleScenario.process.step.operation>?
[]< Indicates an alternative step that can be taken instead of the sub-process, scenario or operation. E.g. to represent non-happy-path/exceptional/atypical circumstances.; (xsd)alternative:ExampleScenario.process.step.alternative>*
< If true, indicates that, following this step, there is a pause in the flow and the subsequent step will occur at some later time (triggered by some event).; (xsd)pause:boolean>?🔗 Indicates an alternative step that can be taken instead of the sub-process, scenario or operation. E.g. to represent non-happy-path/exceptional/atypical circumstances.ExampleScenario.process.step.alternative(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The label to display for the alternative that gives a sense of the circumstance in which the alternative should be invoked.; (xsd)title:string>
< A human-readable description of the alternative explaining when the alternative should occur rather than the base step.; (xsd)description:markdown>?
[]< Indicates the operation, sub-process or scenario that happens if the alternative option is selected.; (xsd)step:ExampleScenario.process.step>*🔗 The step represents a single operation invoked on receiver by sender.ExampleScenario.process.step.operation(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The standardized type of action (FHIR or otherwise). Binding: testscript-operation-codes (extensible, ); (xsd)type:Coding>?
< A short descriptive label the step to be used in tables or diagrams.; (xsd)title:string>
< The system that invokes the action/transmits the data. This must either be the 'key' of one of the actors defined in this scenario or the special keyword 'OTHER' if the initiator is not one of the actors defined for the scenario. (Multiple references to 'OTHER' don't necessarily indicate the same actor.); (xsd)initiator:string>?
< The system on which the action is invoked/receives the data. This must either be the 'key' of one of the actors defined in this scenario or the special keyword 'OTHER' if the receiver is not one of the actors defined for the scenario. (Multiple references to 'OTHER' don't necessarily indicate the same actor.) In some cases, receiver could be same as sender if representing a local operation; (xsd)receiver:string>?
< An explanation of what the operation represents and what it does. This should contain information not already present in the process step. It's more of a description of what the operation in general does - if not already evident from the operation.type; (xsd)description:markdown>?
< If false, the initiator is deactivated right after the operation. De-activation of an actor means they have no further role until such time as they are the recipient of an operation.; (xsd)initiatorActive:boolean>?
< If false, the receiver is deactivated right after the operation. De-activation of an actor means they have no further role until such time as they are the recipient of an operation.; (xsd)receiverActive:boolean>?
< A reference to the instance that is transmitted from requester to receiver as part of the invocation of the operation.; (xsd)request:ExampleScenario.instance.containedInstance>?
< A reference to the instance that is transmitted from receiver to requester as part of the operation's synchronous response (if any).; (xsd)response:ExampleScenario.instance.containedInstance>?🔗 A ValueSet resource instance specifies a set of codes drawn from one or more code systems, intended for use in a particular context. Value sets link between [CodeSystem](codesystem.html) definitions and their use in [coded elements](terminologies.html).executablevalueset(xsd)(doc)=
<#base:shareablevalueset>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< An Extension; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< An absolute URI that is used to identify this value set when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this value set is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the value set is stored on different servers. Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.
The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions).
In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.; (xsd)url:uri>
[]< A formal identifier that is used to identify this value set when it is represented in other formats, or referenced in a specification, model, design or an instance. Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this value set outside of FHIR, where it is not possible to use the logical URI.; (xsd)identifier:Identifier>*
< The identifier that is used to identify this version of the value set when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the value set author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. There may be different value set instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the value set with the format [url]|[version]. The version SHOULD NOT contain a '#' - see [Business Version](resource.html#bv-format).; (xsd)version:string>
< Indicates the mechanism used to compare versions to determine which ValueSet is more current. If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined. Binding: version-algorithm (extensible, ); (xsd)versionAlgorithm:(<Coding>
|<string>)>?
< A natural language name identifying the value set. This name should be usable as an identifier for the module by machine processing applications such as code generation. The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.A name should be provided unless the value set is a contained resource (e.g. an anonymous value set in a profile). Most registries will require a name.; (xsd)name:string>?
< A short, descriptive, user-friendly title for the value set. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.; (xsd)title:string>
< The status of this value set. Enables tracking the life-cycle of the content. The status of the value set applies to the value set definition (ValueSet.compose) and the associated ValueSet metadata. Expansions do not have a state. Allows filtering of value sets that are appropriate for use versus not.See also the [http://hl7.org/fhir/StructureDefinition/valueset-workflowStatusDescription](http://hl7.org/fhir/extensions/StructureDefinition-valueset-workflowStatusDescription.html) extension for additional status information related to the editorial process.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization). Binding: publication-status (required, The lifecycle status of an artifact.); (xsd)status:code>
< A Boolean value to indicate that this value set is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. Allows filtering of value sets that are appropriate for use versus not.; (xsd)experimental:boolean>
< The date (and optionally time) when the value set metadata or content logical definition (.compose) was created or revised. Note that this is not the same as the meta.lastUpdated which is specific to an instance of a value set resource on a server. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)date:dateTime>?
< The name of the organization or individual responsible for the release and ongoing maintenance of the value set. Usually an organization but may be an individual. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the value set. This item SHOULD be populated unless the information is available from context.; (xsd)publisher:string>?
[]< Contact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)contact:ContactDetail>*
< A free text natural language description of the value set from a consumer's perspective. The textual description specifies the span of meanings for concepts to be included within the Value Set Expansion, and also may specify the intended use and limitations of the Value Set. Description SHOULD contain instructions for clinical or administrative use and interpretation and information about misuse. Description SHOULD be populated unless the information is available from context. Description SHOULD be populated unless the value set is a contained resource (e.g. a value set defined solely in the context of a profile).; (xsd)description:markdown>
[]< The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate value set instances. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.; (xsd)useContext:UsageContext>*
[]< A legal or geographic region in which the value set is intended to be used. It may be possible for the value set to be used in jurisdictions other than those for which it was originally designed or intended.
DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.) Binding: jurisdiction (extensible, Countries and regions within which this artifact is targeted for use.); (xsd)jurisdiction:CodeableConcept>*
< If this is set to 'true', then no new versions of the content logical definition can be created. Note: Other metadata might still change. Normally immutability is set to 'false', which is the default assumption if it is not populated. Note that the implication is that if this is set to 'true', there may be only one ValueSet version for this definition. Immutability tends to be set to 'true' in one of two cases: - Where the value set, by the nature of its usage, cannot change. For example "All specializations of ACT in ActClassCode" - Where there's no safe way to express the "Purpose" such that someone else could safely make changes to the value set definition. Source workflow control must guarantee that the same URI always yields the same definition.; (xsd)immutable:boolean>?
< Explanation of why this value set is needed and why it has been designed as it has. This element does not describe the usage of the value set. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this value set.; (xsd)purpose:markdown>?
< A copyright statement relating to the value set and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the value set. Frequently, the copyright differs between the value set and the codes that are included. The copyright statement should clearly differentiate between these when required.; (xsd)copyright:markdown>?
< A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved'). The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.; (xsd)copyrightLabel:string>?
< The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)approvalDate:date>?
< The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. If specified, this date follows the original approval date.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)lastReviewDate:date>?
< The period during which the ValueSet content was or is planned to be in active use. The effective period for a ValueSet determines when the content is applicable for usage and is independent of publication and review dates. For example, a valueset intended to be used for the year 2016 might be published in 2015.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)effectivePeriod:Period>?
[]< Descriptions related to the content of the ValueSet. Topics provide a high-level categorization as well as keywords for the ValueSet that can be useful for filtering and searching. DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'topic' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#topic and useContext.valueCodeableConcept indicating the topic) Binding: definition-topic (example, ); (xsd)topic:CodeableConcept>*
[]< An individiual or organization primarily involved in the creation and maintenance of the ValueSet.; (xsd)author:ContactDetail>*
[]< An individual or organization primarily responsible for internal coherence of the ValueSet.; (xsd)editor:ContactDetail>*
[]< An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the ValueSet. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)reviewer:ContactDetail>*
[]< An individual or organization asserted by the publisher to be responsible for officially endorsing the ValueSet for use in some setting. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)endorser:ContactDetail>*
[]< Related artifacts such as additional documentation, justification, dependencies, bibliographic references, and predecessor and successor artifacts. Each related artifact is either an attachment, or a reference to another resource, but not both.; (xsd)relatedArtifact:RelatedArtifact>*
< A set of criteria that define the contents of the value set by including or excluding codes selected from the specified code system(s) that the value set draws from. This is also known as the Content Logical Definition (CLD).; (xsd)compose:executablevalueset.compose>?
< A value set can also be "expanded", where the value set is turned into a simple collection of enumerated codes. This element holds the expansion, if it has been performed. Expansion is performed to produce a collection of codes that are ready to use for data entry or validation. Value set expansions are always considered to be stateless - they are a record of the set of codes in the value set at a point in time under a given set of conditions, and are not subject to ongoing maintenance.
Expansion.parameter is a simplified list of parameters - a subset of the features of the [Parameters](parameters.html) resource.; (xsd)expansion:executablevalueset.expansion>
< Description of the semantic space the Value Set Expansion is intended to cover and should further clarify the text in ValueSet.description.; (xsd)scope:executablevalueset.scope>?
[]< Defines a knowledge representation level provided by this knowledge artifact.; (xsd)knowledgeRepresentationLevel:Extension>*
< A reference to the authoritative accessible, persisted source of truth of the entire Value Set Definition, including textual information and available versions. If this extension is not present, then the canonical URL (ValueSet.url) also serves the purpose of specifying the authoritative source. A difference between the canonical URL and the authoritiative source might arise in some cases due to ongoing organization restructuring, etc., and in those cases this extension may be used. The URL of the authoritative source is intended to be resolvable but that cannot be guaranteed. The designated "authoritative source" is normally expected to be able to generate a valid expansion of the value set, and if for some reason it cannot then the valueset-trusted-expansion should be used.; (xsd)authoritativeSource:Extension>?
< An extra warning about the correct use of the value set.; (xsd)usageWarning:Extension>🔗 A set of criteria that define the contents of the value set by including or excluding codes selected from the specified code system(s) that the value set draws from. This is also known as the Content Logical Definition (CLD).executablevalueset.compose(xsd)(doc)=
<#base:ValueSet.compose>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The Locked Date is the effective date that is used to determine the version of all referenced Code Systems and Value Set Definitions included in the compose that are not already tied to a specific version. With a defined lockedDate the value set is considered "Locked". Otherwise, the value set may have different expansions as underlying code systems and/or value sets evolve. The interpretation of lockedDate is often dependent on the context - e.g. a SNOMED CT derived value set with a lockedDate will have a different expansion in USA than in UK. If a value set specifies a version for include and exclude statements, and also specifies a locked date, the specified versions need to be available that date, or the value set will not be usable.; (xsd)lockedDate:date>?
< Whether inactive codes - codes that are not approved for current use - are in the value set. If inactive = true, inactive codes are to be included in the expansion, if inactive = false, the inactive codes will not be included in the expansion. If absent, the behavior is determined by the implementation, or by the applicable $expand parameters (but generally, inactive codes would be expected to be included). Note that in the FHIR terminology framework, "deprecated" does not mean inactive, but in some code systems, e.g. LOINC, "deprecated" does mean inactive. Code systems should define what codes are considered to be inactive. If this is not clearly defined (including in the FHIR code system resource), then all codes are assumed to be active.
The Value Set Definition specification defines an ActiveOnly element, which is the reverse of this element e.g. (ValueSet.compose.inactive=FALSE) is the same as (VSD.ActiveOnly=TRUE).; (xsd)inactive:boolean>?
[]< Include one or more codes from a code system or other value set(s). All the conditions in an include must be true. If a system is listed, all the codes from the system are listed. If one or more filters are listed, all of the filters must apply. If one or more value sets are listed, the codes must be in all the value sets. E.g. each include is 'include all the codes that meet all these conditions'.; (xsd)include:executablevalueset.compose.include>+
[]< Exclude one or more codes from the value set based on code system filters and/or other value sets. Usually this is used to selectively exclude codes that were included by subsumption in the inclusions. Any display names specified for the codes are ignored.; (xsd)exclude:ValueSet.compose.include>*
[]< A property to return in the expansion, if the client doesn't ask for any particular properties. May be either a code from the code system definition (convenient) or a the formal URI that refers to the property. The special value '*' means all properties known to the server. Note that property names can clash, so using a URI is recommended.; (xsd)property:string>*🔗 Include one or more codes from a code system or other value set(s). All the conditions in an include must be true. If a system is listed, all the codes from the system are listed. If one or more filters are listed, all of the filters must apply. If one or more value sets are listed, the codes must be in all the value sets. E.g. each include is 'include all the codes that meet all these conditions'.executablevalueset.compose.include(xsd)(doc)=
<#base:ValueSet.compose.include>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< An absolute URI which is the code system from which the selected codes come from. If there are no codes or filters, the entire code system is included. Note that the set of codes that are included may contain abstract codes. See ''Coding.system'' for further documentation about the correct value for the system element.; (xsd)system:uri>?
< The version of the code system that the codes are selected from, or the special version '*' for all versions. This is used when selecting the descendants of a concept - they may change between versions. If no version is specified, then the exact contents of the value set might not be known until a context of use binds it to a particular version. The special value '*' means all versions; It is at server discretion regarding expansions and which versions must be supported.; (xsd)version:string>?
[]< Specifies a concept to be included or excluded. The list of concepts is considered ordered, though the order might not have any particular significance. Typically, the order of an expansion follows that defined in the compose element.; (xsd)concept:executablevalueset.compose.include.concept>*
[]< Select concepts by specifying a matching criterion based on the properties (including relationships) defined by the system, or on filters defined by the system. If multiple filters are specified within the include, they SHALL all be true. Selecting codes by specifying filters based on properties is only possible where the underlying code system defines appropriate properties. Note that in some cases, the underlying code system defines the logical concepts but not the literal codes for the concepts. In such cases, the literal definitions may be provided by a third party.; (xsd)filter:executablevalueset.compose.include.filter>*
[]< Selects the concepts found in this value set (based on its value set definition). This is an absolute URI that is a reference to ValueSet.url. If multiple value sets are specified this includes the intersection of the contents of all of the referenced value sets. The value set URI is either a logical reference to a defined value set such as a [SNOMED CT reference set](https://terminology.hl7.org/SNOMEDCT.html), or a direct reference to a value set definition using ValueSet.url. The reference might not refer to an actual FHIR ValueSet resource; in this case, whatever is referred to is an implicit definition of a value set that needs to be clear about how versions are resolved.; (xsd)valueSet:ValueSet*>*
< A copyright statement for the specific code system asserted by the containing ValueSet.compose.include element's system value (if the associated ValueSet.compose.include.version element is not present); or the code system and version combination (if the associated ValueSet.compose.include.version element is present).; (xsd)copyright:string>?🔗 Specifies a concept to be included or excluded. The list of concepts is considered ordered, though the order might not have any particular significance. Typically, the order of an expansion follows that defined in the compose element.executablevalueset.compose.include.concept(xsd)(doc)=
<#base:ValueSet.compose.include.concept>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Specifies a code for the concept to be included or excluded. Expressions are allowed if defined by the underlying code system.; (xsd)code>
< The text to display to the user for this concept in the context of this valueset. If no display is provided, then applications using the value set use the display specified for the code by the system. The value set resource allows for an alternative display to be specified for when this concept is used in this particular value set. See notes in the value set narrative about the correct use of this element.; (xsd)display:string>?
[]< Additional representations for this concept when used in this value set - other languages, aliases, specialized purposes, used for particular purposes, etc. Concepts have both a ```display``` and an array of ```designation```. The display is equivalent to a special designation with an implied ```designation.use``` of "primary code" and a language equal to the [Resource Language](resource.html#language).; (xsd)designation:executablevalueset.compose.include.concept.designation>*🔗 Additional representations for this concept when used in this value set - other languages, aliases, specialized purposes, used for particular purposes, etc. Concepts have both a ```display``` and an array of ```designation```. The display is equivalent to a special designation with an implied ```designation.use``` of "primary code" and a language equal to the [Resource Language](resource.html#language).executablevalueset.compose.include.concept.designation(xsd)(doc)=
<#base:ValueSet.compose.include.concept.designation>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The language this designation is defined for. In the absence of a language, the resource language applies. Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< A code that represents types of uses of designations. If no use is provided, the designation can be assumed to be suitable for general display to a human user. Binding: designation-use (extensible, Details of how a designation would be used.); (xsd)use:Coding>?
[]< Additional codes that detail how this designation would be used, if there is more than one use. This was added rather than increasing the cardinality of .use to 0..* in order to maintain backward compatibility. Binding: designation-use (extensible, Details of how a designation would be used.); (xsd)additionalUse:Coding>*
< The text value for this designation.; (xsd)value:string>🔗 Select concepts by specifying a matching criterion based on the properties (including relationships) defined by the system, or on filters defined by the system. If multiple filters are specified within the include, they SHALL all be true. Selecting codes by specifying filters based on properties is only possible where the underlying code system defines appropriate properties. Note that in some cases, the underlying code system defines the logical concepts but not the literal codes for the concepts. In such cases, the literal definitions may be provided by a third party.executablevalueset.compose.include.filter(xsd)(doc)=
<#base:ValueSet.compose.include.filter>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A code that identifies a property or a filter defined in the code system.; (xsd)property:code>
< The kind of operation to perform as a part of the filter criteria. In case filter.property represents a property of the system, the operation applies to the selected property. In case filter.property represents a filter of the system, the operation SHALL match one of the CodeSystem.filter.operator values. Binding: filter-operator (required, The kind of operation to perform as a part of a property based filter.); (xsd)op:code>
< The match value may be either a code defined by the system, or a string value, which is a regex match on the literal string of the property value (if the filter represents a property defined in CodeSystem) or of the system filter value (if the filter represents a filter defined in CodeSystem) when the operation is 'regex', or one of the values (true and false), when the operation is 'exists'. Use regex matching with care - full regex matching on every SNOMED CT term is prohibitive, for example.; (xsd)value:string>🔗 A value set can also be "expanded", where the value set is turned into a simple collection of enumerated codes. This element holds the expansion, if it has been performed. Expansion is performed to produce a collection of codes that are ready to use for data entry or validation. Value set expansions are always considered to be stateless - they are a record of the set of codes in the value set at a point in time under a given set of conditions, and are not subject to ongoing maintenance.
Expansion.parameter is a simplified list of parameters - a subset of the features of the [Parameters](parameters.html) resource.executablevalueset.expansion(xsd)(doc)=
<#base:ValueSet.expansion>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< An identifier that uniquely identifies this expansion of the valueset, based on a unique combination of the provided parameters, the system default parameters, and the underlying system code system versions etc. Systems may re-use the same identifier as long as those factors remain the same, and the expansion is the same, but are not required to do so. This is a business identifier. Typically, this uri is a UUID (e.g. urn:uuid:8230ff20-c97a-4167-a59d-dc2cb9df16dd).; (xsd)identifier:uri>?
< As per paging Search results, the next URLs are opaque to the client, have no dictated structure, and only the server understands them. Clients SHOULD use the next link, if present, to page through expansion results in preference to using the offset and count parameters. Due to the optional nature of the next link, its absence does not necessarily indicate that it is the last page of results. Instead, as the offset and count parameters SHALL be populated when paging, clients can reliably use the count/offset parameters to determine whether the whole expansion is returned.; (xsd)next:uri>?
< The time at which the expansion was produced by the expanding system. This SHOULD be a fully populated instant, but in some circumstances, value sets are expanded by hand, and the expansion is published without that precision.; (xsd)timestamp:dateTime>
< The total number of concepts in the expansion. If the number of concept nodes in this resource is less than the stated number, then the server can return more using the offset parameter. Paging only applies to flat expansions.; (xsd)total:integer>?
< If paging is being used, the offset at which this resource starts. I.e. this resource is a partial view into the expansion. If paging is not being used, this element SHALL NOT be present. Paging only applies to flat expansions. If a filter is applied, the count is the number of concepts that matched the filter, not the number of concepts in an unfiltered view of the expansion.; (xsd)offset:integer>?
[]< A parameter that controlled the expansion process. These parameters may be used by users of expanded value sets to check whether the expansion is suitable for a particular purpose, or to pick the correct expansion. The server decides which parameters to include here, but at a minimum, the list SHOULD include all of the parameters that affect the $expand operation. If the expansion will be persisted all of these parameters SHALL be included. If the codeSystem on the server has a specified version then this version SHALL be provided as a parameter in the expansion (note that not all code systems have a version).; (xsd)parameter:executablevalueset.expansion.parameter>*
[]< A property defines an additional slot through which additional information can be provided about a concept.; (xsd)property:executablevalueset.expansion.property>*
[]< The codes that are contained in the value set expansion.; (xsd)contains:executablevalueset.expansion.contains>*🔗 The codes that are contained in the value set expansion.executablevalueset.expansion.contains(xsd)(doc)=
<#base:ValueSet.expansion.contains>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< An absolute URI which is the code system in which the code for this item in the expansion is defined.; (xsd)system:uri>?
< If true, this entry is included in the expansion for navigational purposes, and the user cannot select the code directly as a proper value. This should not be understood to exclude its use for searching (e.g. by subsumption testing). The client should know whether it is appropriate for the user to select an abstract code or not.; (xsd)abstract:boolean>?
< If the concept is inactive in the code system that defines it. Inactive codes are those that are no longer to be used, but are maintained by the code system for understanding legacy data. It might not be known or specified whether a concept is inactive (and it may depend on the context of use). This should only have a value if the concept is inactive.; (xsd)inactive:boolean>?
< The version of the code system from this code was taken. 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. The exact value of the version string is specified by the system from which the code is derived.; (xsd)version:string>?
< The code for this item in the expansion hierarchy. If this code is missing the entry in the hierarchy is a place holder (abstract) and does not represent a valid code in the value set.; (xsd)code>
< The recommended display for this item in the expansion.; (xsd)display:string>?
[]< Additional representations for this item - other languages, aliases, specialized purposes, used for particular purposes, etc. These are relevant when the conditions of the expansion do not fix to a single correct representation. The designations provided must be based on the value set and code system definitions.; (xsd)designation:ValueSet.compose.include.concept.designation>*
[]< A property value for this concept.; (xsd)property:executablevalueset.expansion.contains.property>*
[]< Other codes and entries contained under this entry in the hierarchy. If the expansion uses this element, there is no implication about the logical relationship between them, and the structure cannot be used for logical inferencing. The structure exists to provide navigational assistance for helping human users to locate codes in the expansion.; (xsd)contains:ValueSet.expansion.contains>*🔗 A property value for this concept.executablevalueset.expansion.contains.property(xsd)(doc)=
<#base:ValueSet.expansion.contains.property>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A code that is a reference to ValueSet.expansion.property.code.; (xsd)code>
(<valueBoolean:boolean>
|<valueCode:code>
|<valueCoding:Coding>
|<valueDateTime:dateTime>
|<valueDecimal:decimal>
|<valueInteger:integer>
|<valueString:string>)
[]< A subproperty value for this concept.; (xsd)subProperty:executablevalueset.expansion.contains.property.subProperty>*🔗 A subproperty value for this concept.executablevalueset.expansion.contains.property.subProperty(xsd)(doc)=
<#base:ValueSet.expansion.contains.property.subProperty>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A code that is a reference to ValueSet.expansion.property.code.; (xsd)code>
(<valueBoolean:boolean>
|<valueCode:code>
|<valueCoding:Coding>
|<valueDateTime:dateTime>
|<valueDecimal:decimal>
|<valueInteger:integer>
|<valueString:string>)🔗 A parameter that controlled the expansion process. These parameters may be used by users of expanded value sets to check whether the expansion is suitable for a particular purpose, or to pick the correct expansion. The server decides which parameters to include here, but at a minimum, the list SHOULD include all of the parameters that affect the $expand operation. If the expansion will be persisted all of these parameters SHALL be included. If the codeSystem on the server has a specified version then this version SHALL be provided as a parameter in the expansion (note that not all code systems have a version).executablevalueset.expansion.parameter(xsd)(doc)=
<#base:ValueSet.expansion.parameter>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Name of the input parameter to the $expand operation; may be a server-assigned name for additional default or other server-supplied parameters used to control the expansion process. The names are assigned at the discretion of the server.; (xsd)name:string>
(<valueBoolean:boolean>
|<valueCode:code>
|<valueDateTime:dateTime>
|<valueDecimal:decimal>
|<valueInteger:integer>
|<valueString:string>
|<valueUri:uri>)?🔗 A property defines an additional slot through which additional information can be provided about a concept.executablevalueset.expansion.property(xsd)(doc)=
<#base:ValueSet.expansion.property>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A code that is used to identify the property. The code is used in ValueSet.expansion.contains.property.code.; (xsd)code>
< Reference to the formal meaning of the property. One possible source of meaning is the [Concept Properties](codesystem-concept-properties.html) code system.; (xsd)uri>?🔗 Description of the semantic space the Value Set Expansion is intended to cover and should further clarify the text in ValueSet.description.executablevalueset.scope(xsd)(doc)=
<#base:ValueSet.scope>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Criteria describing which concepts or codes should be included and why.; (xsd)inclusionCriteria:string>?
< Criteria describing which concepts or codes should be excluded and why.; (xsd)exclusionCriteria:string>?🔗 An extra warning about the correct use of the value set.executablevalueset.usageWarning(xsd)(doc)=
<#base:Extension>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
< An Extension; (xsd)extension:Extension>{0,0}
< 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. http://hl7.org/fhir/StructureDefinition/valueset-warning; (xsd)url:string>
< Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). This value set contains a point-in-time expansion enumerating the codes that meet the value set intent. As new versions of the code systems used by the value set are released, the contents of this expansion will need to be updated to incorporate newly defined codes that meet the value set intent. Before, and periodically during production use, the value set expansion contents SHOULD be updated.; (xsd)value:markdown>🔗 This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.ExplanationOfBenefit(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< A unique identifier assigned to this explanation of benefit.; (xsd)identifier:Identifier>*
[]< Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners.; (xsd)traceNumber:Identifier>*
< The status of the resource instance. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. Binding: explanationofbenefit-status (required, A code specifying the state of the resource instance.); (xsd)status:code>
< The category of claim, e.g. oral, pharmacy, vision, institutional, professional. The majority of jurisdictions use: oral, pharmacy, vision, professional and institutional, or variants on those terms, as the general styles of claims. The valueset is extensible to accommodate other jurisdictional requirements. Binding: claim-type (extensible, The type or discipline-style of the claim.); (xsd)type:CodeableConcept>
< A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service. This may contain the local bill type codes such as the US UB-04 bill type code. Binding: claim-subtype (example, A more granular claim typecode.); (xsd)subType:CodeableConcept>?
< A code to indicate whether the nature of the request is: Claim - A request to an Insurer to adjudicate the supplied charges for health care goods and services under the identified policy and to pay the determined Benefit amount, if any; Preauthorization - A request to an Insurer to adjudicate the supplied proposed future charges for health care goods and services under the identified policy and to approve the services and provide the expected benefit amounts and potentially to reserve funds to pay the benefits when Claims for the indicated services are later submitted; or, Pre-determination - A request to an Insurer to adjudicate the supplied 'what if' charges for health care goods and services under the identified policy and report back what the Benefit payable would be had the services actually been provided. Binding: claim-use (required, Complete, proposed, exploratory, other.); (xsd)use:code>
< The party to whom the professional services and/or products have been supplied or are being considered and for whom actual for forecast reimbursement is sought.; (xsd)patient:Patient*>
< The period for which charges are being submitted. Typically this would be today or in the past for a claim, and today or in the future for preauthorizations and prodeterminations. Typically line item dates of service should fall within the billing period if one is specified.; (xsd)billablePeriod:Period>?
< The date this resource was created.; (xsd)created:dateTime>
< Individual who created the claim, predetermination or preauthorization.; (xsd)enterer:(<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>?
< The party responsible for authorization, adjudication and reimbursement.; (xsd)insurer:Organization*>?
< The provider which is responsible for the claim, predetermination or preauthorization. Typically this field would be 1..1 where this party is accountable for the data content within the claim but is not necessarily the facility, provider group or practitioner who provided the products and services listed within this claim resource. This field is the Billing Provider, for example, a facility, provider group, lab or practitioner.; (xsd)provider:(<Organization>
|<Practitioner>
|<PractitionerRole>)>?
< The provider-required urgency of processing the request. Typical values include: stat, normal deferred. If a claim processor is unable to complete the processing as per the priority then they should generate an error and not process the request. Binding: process-priority (example, The timeliness with which processing is required: stat, normal, deferred.); (xsd)priority:CodeableConcept>?
< A code to indicate whether and for whom funds are to be reserved for future claims. This field is only used for preauthorizations. Binding: fundsreserve (example, For whom funds are to be reserved: (Patient, Provider, None).); (xsd)fundsReserveRequested:CodeableConcept>?
< A code, used only on a response to a preauthorization, to indicate whether the benefits payable have been reserved and for whom. Fund would be release by a future claim quoting the preAuthRef of this response. Examples of values include: provider, patient, none. Binding: fundsreserve (example, For whom funds are to be reserved: (Patient, Provider, None).); (xsd)fundsReserve:CodeableConcept>?
[]< Other claims which are related to this claim such as prior submissions or claims for related services or for the same event. For example, for the original treatment and follow-up exams.; (xsd)related:ExplanationOfBenefit.related>*
< Prescription is the document/authorization given to the claim author for them to provide products and services for which consideration (reimbursement) is sought. Could be a RX for medications, an 'order' for oxygen or wheelchair or physiotherapy treatments.; (xsd)prescription:(<MedicationRequest>
|<VisionPrescription>)>?
< Original prescription which has been superseded by this prescription to support the dispensing of pharmacy services, medications or products. For example, a physician may prescribe a medication which the pharmacy determines is contraindicated, or for which the patient has an intolerance, and therefor issues a new prescription for an alternate medication which has the same therapeutic intent. The prescription from the pharmacy becomes the 'prescription' and that from the physician becomes the 'original prescription'.; (xsd)originalPrescription:MedicationRequest*>?
[]< Information code for an event with a corresponding date or period.; (xsd)event:ExplanationOfBenefit.event>*
< The party to be reimbursed for cost of the products and services according to the terms of the policy. Often providers agree to receive the benefits payable to reduce the near-term costs to the patient. The insurer may decline to pay the provider and may choose to pay the subscriber instead.; (xsd)payee:ExplanationOfBenefit.payee>?
< The referral information received by the claim author, it is not to be used when the author generates a referral for a patient. A copy of that referral may be provided as supporting information. Some insurers require proof of referral to pay for services or to pay specialist rates for services. The referral resource which lists the date, practitioner, reason and other supporting information.; (xsd)referral:ServiceRequest*>?
[]< Healthcare encounters related to this claim.; (xsd)encounter:Encounter*>*
< Facility where the services were provided.; (xsd)facility:(<Location>
|<Organization>)>?
< The business identifier for the instance of the adjudication request: claim predetermination or preauthorization.; (xsd)claim:Claim*>?
< The business identifier for the instance of the adjudication response: claim, predetermination or preauthorization response.; (xsd)claimResponse:ClaimResponse*>?
< The outcome of the claim, predetermination, or preauthorization processing. The resource may be used to indicate that the Claim/Preauthorization/Pre-determination has been received but processing has not begun (queued); that it has been processed and one or more errors have been detected (error); no errors were detected and some of the adjudication processing has been performed (partial); or all of the adjudication processing has completed without errors (complete). Binding: claim-outcome (required, The result of the claim processing.); (xsd)outcome:code>
< The result of the claim, predetermination, or preauthorization adjudication. The element is used to indicate the current state of the adjudication overall for the claim resource, for example: the request has been held (pended) for adjudication processing, for manual review or other reasons; that it has been processed and will be paid, or the outstanding paid, as submitted (approved); that no amount will be paid (denied); or that some amount between zero and the submitted amoutn will be paid (partial). Binding: claim-decision (example, ); (xsd)decision:CodeableConcept>?
< A human readable description of the status of the adjudication.; (xsd)disposition:string>?
[]< Reference from the Insurer which is used in later communications which refers to this adjudication. This value is only present on preauthorization adjudications.; (xsd)preAuthRef:string>*
[]< The timeframe during which the supplied preauthorization reference may be quoted on claims to obtain the adjudication as provided. This value is only present on preauthorization adjudications.; (xsd)preAuthRefPeriod:Period>*
< A package billing code or bundle code used to group products and services to a particular health condition (such as heart attack) which is based on a predetermined grouping code system. For example DRG (Diagnosis Related Group) or a bundled billing code. A patient may have a diagnosis of a Myocardial Infarction and a DRG for HeartAttack would be assigned. The Claim item (and possible subsequent claims) would refer to the DRG for those line items that were for services related to the heart attack event. Binding: ex-diagnosisrelatedgroup (example, ); (xsd)diagnosisRelatedGroup:CodeableConcept>?
[]< The members of the team who provided the products and services.; (xsd)careTeam:ExplanationOfBenefit.careTeam>*
[]< Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues. Often there are multiple jurisdiction specific valuesets which are required.; (xsd)supportingInfo:ExplanationOfBenefit.supportingInfo>*
[]< Information about diagnoses relevant to the claim items.; (xsd)diagnosis:ExplanationOfBenefit.diagnosis>*
[]< Procedures performed on the patient relevant to the billing items with the claim.; (xsd)procedure:ExplanationOfBenefit.procedure>*
< This indicates the relative order of a series of EOBs related to different coverages for the same suite of services.; (xsd)precedence:positiveInt>?
[]< Financial instruments for reimbursement for the health care products and services specified on the claim. All insurance coverages for the patient which may be applicable for reimbursement, of the products and services listed in the claim, are typically provided in the claim to allow insurers to confirm the ordering of the insurance coverages relative to local 'coordination of benefit' rules. One coverage (and only one) with 'focal=true' is to be used in the adjudication of this claim. Coverages appearing before the focal Coverage in the list, and where 'Coverage.subrogation=false', should provide a reference to the ClaimResponse containing the adjudication results of the prior claim.; (xsd)insurance:ExplanationOfBenefit.insurance>*
< Details of a accident which resulted in injuries which required the products and services listed in the claim.; (xsd)accident:ExplanationOfBenefit.accident>?
< The amount paid by the patient, in total at the claim claim level or specifically for the item and detail level, to the provider for goods and services.; (xsd)patientPaid:Money>?
[]< A claim line. Either a simple (a product or service) or a 'group' of details which can also be a simple items or groups of sub-details.; (xsd)item:ExplanationOfBenefit.item>*
[]< The first-tier service adjudications for payor added product or service lines.; (xsd)addItem:ExplanationOfBenefit.addItem>*
[]< The adjudication results which are presented at the header level rather than at the line-item or add-item levels.; (xsd)adjudication:ExplanationOfBenefit.item.adjudication>*
[]< Categorized monetary totals for the adjudication. Totals for amounts submitted, co-pays, benefits payable etc.; (xsd)total:ExplanationOfBenefit.total>*
< Payment details for the adjudication of the claim.; (xsd)payment:ExplanationOfBenefit.payment>?
< A code for the form to be used for printing the content. May be needed to identify specific jurisdictional forms. Binding: forms (example, The forms codes.); (xsd)formCode:CodeableConcept>?
< The actual form, by reference or inclusion, for printing the content or an EOB. Needed to permit insurers to include the actual form.; (xsd)form:Attachment>?
[]< A note that describes or explains adjudication results in a human readable form.; (xsd)processNote:ExplanationOfBenefit.processNote>*
< The term of the benefits documented in this response. Not applicable when use=claim.; (xsd)benefitPeriod:Period>?
[]< Balance by Benefit Category.; (xsd)benefitBalance:ExplanationOfBenefit.benefitBalance>*🔗 Details of a accident which resulted in injuries which required the products and services listed in the claim.ExplanationOfBenefit.accident(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Date of an accident event related to the products and services contained in the claim. The date of the accident has to precede the dates of the products and services but within a reasonable timeframe.; (xsd)date>?
< The type or context of the accident event for the purposes of selection of potential insurance coverages and determination of coordination between insurers. Binding: http://terminology.hl7.org/ValueSet/v3-ActIncidentCode (extensible, Type of accident: work place, auto, etc.); (xsd)type:CodeableConcept>?
< The physical location of the accident event.; (xsd)location:(<Address>
|<Location>)>?🔗 The first-tier service adjudications for payor added product or service lines.ExplanationOfBenefit.addItem(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< Claim items which this service line is intended to replace.; (xsd)itemSequence:positiveInt>*
[]< The sequence number of the details within the claim item which this line is intended to replace.; (xsd)detailSequence:positiveInt>*
[]< The sequence number of the sub-details woithin the details within the claim item which this line is intended to replace.; (xsd)subDetailSequence:positiveInt>*
[]< Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners.; (xsd)traceNumber:Identifier>*
[]< The providers who are authorized for the services rendered to the patient.; (xsd)provider:(<Organization>
|<Practitioner>
|<PractitionerRole>)>*
< The type of revenue or cost center providing the product and/or service. Binding: ex-revenue-center (example, Codes for the revenue or cost centers supplying the service and/or products.); (xsd)revenue:CodeableConcept>?
< When the value is a group code then this item collects a set of related item details, otherwise this contains the product, service, drug or other billing code for the item. This element may be the start of a range of .productOrService codes used in conjunction with .productOrServiceEnd or it may be a solo element where .productOrServiceEnd is not used. If this is an actual service or product line, i.e. not a Group, then use code to indicate the Professional Service or Product supplied (e.g. CTP, HCPCS, USCLS, ICD10, NCPDP, DIN, RxNorm, ACHI, CCI). If a grouping item then use a group code to indicate the type of thing being grouped e.g. 'glasses' or 'compound'. Binding: service-uscls (example, Allowable service and product codes.); (xsd)productOrService:CodeableConcept>?
< This contains the end of a range of product, service, drug or other billing codes for the item. This element is not used when the .productOrService is a group code. This value may only be present when a .productOfService code has been provided to convey the start of the range. Typically this value may be used only with preauthorizations and not with claims. Binding: service-uscls (example, ); (xsd)productOrServiceEnd:CodeableConcept>?
[]< Request or Referral for Goods or Service to be rendered.; (xsd)request:(<DeviceRequest>
|<MedicationRequest>
|<NutritionOrder>
|<ServiceRequest>
|<SupplyRequest>
|<VisionPrescription>)>*
[]< Item typification or modifiers codes to convey additional context for the product or service. For example, in Oral whether the treatment is cosmetic or associated with TMJ, or for Medical whether the treatment was outside the clinic or out of office hours. Binding: claim-modifiers (example, Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.); (xsd)modifier:CodeableConcept>*
[]< Identifies the program under which this may be recovered. For example: Neonatal program, child dental program or drug users recovery program. Binding: ex-program-code (example, Program specific reason codes.); (xsd)programCode:CodeableConcept>*
< The date or dates when the service or product was supplied, performed or completed.; (xsd)serviced:(<date>
|<Period>)>?
< Where the product or service was provided. Binding: service-place (example, Place where the service is rendered.); (xsd)location:(<Address>
|<CodeableConcept>
|<Location>)>?
< The amount paid by the patient, in total at the claim claim level or specifically for the item and detail level, to the provider for goods and services.; (xsd)patientPaid:Money>?
< The number of repetitions of a service or product.; (xsd)quantity:SimpleQuantity>?
< If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.; (xsd)unitPrice:Money>?
< A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount. To show a 10% senior's discount, the value entered is: 0.90 (1.00 - 0.10).; (xsd)factor:decimal>?
< The total of taxes applicable for this product or service.; (xsd)tax:Money>?
< The total amount claimed for the group (if a grouper) or the addItem. Net = unit price * quantity * factor. For example, the formula: quantity * unitPrice * factor = net. Quantity and factor are assumed to be 1 if not supplied.; (xsd)net:Money>?
[]< Physical location where the service is performed or applies.; (xsd)bodySite:ExplanationOfBenefit.addItem.bodySite>*
[]< The numbers associated with notes below which apply to the adjudication of this item.; (xsd)noteNumber:positiveInt>*
< The high-level results of the adjudication if adjudication has been performed.; (xsd)reviewOutcome:ExplanationOfBenefit.item.reviewOutcome>?
[]< The adjudication results.; (xsd)adjudication:ExplanationOfBenefit.item.adjudication>*
[]< The second-tier service adjudications for payor added services.; (xsd)detail:ExplanationOfBenefit.addItem.detail>*🔗 Physical location where the service is performed or applies.ExplanationOfBenefit.addItem.bodySite(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< Physical service site on the patient (limb, tooth, etc.). For example, providing a tooth code allows an insurer to identify a provider performing a filling on a tooth that was previously removed. Binding: tooth (example, ); (xsd)site:BodyStructure*>+
[]< A region or surface of the bodySite, e.g. limb region or tooth surface(s). Binding: surface (example, ); (xsd)subSite:CodeableConcept>*🔗 The second-tier service adjudications for payor added services.ExplanationOfBenefit.addItem.detail(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners.; (xsd)traceNumber:Identifier>*
< The type of revenue or cost center providing the product and/or service. Binding: ex-revenue-center (example, Codes for the revenue or cost centers supplying the service and/or products.); (xsd)revenue:CodeableConcept>?
< When the value is a group code then this item collects a set of related item details, otherwise this contains the product, service, drug or other billing code for the item. This element may be the start of a range of .productOrService codes used in conjunction with .productOrServiceEnd or it may be a solo element where .productOrServiceEnd is not used. If this is an actual service or product line, i.e. not a Group, then use code to indicate the Professional Service or Product supplied (e.g. CTP, HCPCS, USCLS, ICD10, NCPDP, DIN, RxNorm, ACHI, CCI). If a grouping item then use a group code to indicate the type of thing being grouped e.g. 'glasses' or 'compound'. Binding: service-uscls (example, Allowable service and product codes.); (xsd)productOrService:CodeableConcept>?
< This contains the end of a range of product, service, drug or other billing codes for the item. This element is not used when the .productOrService is a group code. This value may only be present when a .productOfService code has been provided to convey the start of the range. Typically this value may be used only with preauthorizations and not with claims. Binding: service-uscls (example, ); (xsd)productOrServiceEnd:CodeableConcept>?
[]< Item typification or modifiers codes to convey additional context for the product or service. For example, in Oral whether the treatment is cosmetic or associated with TMJ, or for Medical whether the treatment was outside the clinic or out of office hours. Binding: claim-modifiers (example, Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.); (xsd)modifier:CodeableConcept>*
< The amount paid by the patient, in total at the claim claim level or specifically for the item and detail level, to the provider for goods and services.; (xsd)patientPaid:Money>?
< The number of repetitions of a service or product.; (xsd)quantity:SimpleQuantity>?
< If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.; (xsd)unitPrice:Money>?
< A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount. To show a 10% senior's discount, the value entered is: 0.90 (1.00 - 0.10).; (xsd)factor:decimal>?
< The total of taxes applicable for this product or service.; (xsd)tax:Money>?
< The total amount claimed for the group (if a grouper) or the addItem.detail. Net = unit price * quantity * factor. For example, the formula: quantity * unitPrice * factor = net. Quantity and factor are assumed to be 1 if not supplied.; (xsd)net:Money>?
[]< The numbers associated with notes below which apply to the adjudication of this item.; (xsd)noteNumber:positiveInt>*
< The high-level results of the adjudication if adjudication has been performed.; (xsd)reviewOutcome:ExplanationOfBenefit.item.reviewOutcome>?
[]< The adjudication results.; (xsd)adjudication:ExplanationOfBenefit.item.adjudication>*
[]< The third-tier service adjudications for payor added services.; (xsd)subDetail:ExplanationOfBenefit.addItem.detail.subDetail>*🔗 The third-tier service adjudications for payor added services.ExplanationOfBenefit.addItem.detail.subDetail(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners.; (xsd)traceNumber:Identifier>*
< The type of revenue or cost center providing the product and/or service. Binding: ex-revenue-center (example, Codes for the revenue or cost centers supplying the service and/or products.); (xsd)revenue:CodeableConcept>?
< When the value is a group code then this item collects a set of related item details, otherwise this contains the product, service, drug or other billing code for the item. This element may be the start of a range of .productOrService codes used in conjunction with .productOrServiceEnd or it may be a solo element where .productOrServiceEnd is not used. If this is an actual service or product line, i.e. not a Group, then use code to indicate the Professional Service or Product supplied (e.g. CTP, HCPCS, USCLS, ICD10, NCPDP, DIN, RxNorm, ACHI, CCI). If a grouping item then use a group code to indicate the type of thing being grouped e.g. 'glasses' or 'compound'. Binding: service-uscls (example, Allowable service and product codes.); (xsd)productOrService:CodeableConcept>?
< This contains the end of a range of product, service, drug or other billing codes for the item. This element is not used when the .productOrService is a group code. This value may only be present when a .productOfService code has been provided to convey the start of the range. Typically this value may be used only with preauthorizations and not with claims. Binding: service-uscls (example, ); (xsd)productOrServiceEnd:CodeableConcept>?
[]< Item typification or modifiers codes to convey additional context for the product or service. For example, in Oral whether the treatment is cosmetic or associated with TMJ, or for Medical whether the treatment was outside the clinic or out of office hours. Binding: claim-modifiers (example, Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.); (xsd)modifier:CodeableConcept>*
< The amount paid by the patient, in total at the claim claim level or specifically for the item and detail level, to the provider for goods and services.; (xsd)patientPaid:Money>?
< The number of repetitions of a service or product.; (xsd)quantity:SimpleQuantity>?
< If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.; (xsd)unitPrice:Money>?
< A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount. To show a 10% senior's discount, the value entered is: 0.90 (1.00 - 0.10).; (xsd)factor:decimal>?
< The total of taxes applicable for this product or service.; (xsd)tax:Money>?
< The total amount claimed for the addItem.detail.subDetail. Net = unit price * quantity * factor. For example, the formula: quantity * unitPrice * factor = net. Quantity and factor are assumed to be 1 if not supplied.; (xsd)net:Money>?
[]< The numbers associated with notes below which apply to the adjudication of this item.; (xsd)noteNumber:positiveInt>*
< The high-level results of the adjudication if adjudication has been performed.; (xsd)reviewOutcome:ExplanationOfBenefit.item.reviewOutcome>?
[]< The adjudication results.; (xsd)adjudication:ExplanationOfBenefit.item.adjudication>*🔗 Balance by Benefit Category.ExplanationOfBenefit.benefitBalance(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Code to identify the general type of benefits under which products and services are provided. Examples include Medical Care, Periodontics, Renal Dialysis, Vision Coverage. Binding: ex-benefitcategory (example, Benefit categories such as: oral, medical, vision, oral-basic etc.); (xsd)category:CodeableConcept>
< True if the indicated class of service is excluded from the plan, missing or False indicates the product or service is included in the coverage.; (xsd)excluded:boolean>?
< A short name or tag for the benefit. For example: MED01, or DENT2.; (xsd)name:string>?
< A richer description of the benefit or services covered. For example, 'DENT2 covers 100% of basic, 50% of major but excludes Ortho, Implants and Cosmetic services'.; (xsd)description:string>?
< Is a flag to indicate whether the benefits refer to in-network providers or out-of-network providers. Binding: benefit-network (example, Code to classify in or out of network services.); (xsd)network:CodeableConcept>?
< Indicates if the benefits apply to an individual or to the family. Binding: benefit-unit (example, Unit covered/serviced - individual or family.); (xsd)unit:CodeableConcept>?
< The term or period of the values such as 'maximum lifetime benefit' or 'maximum annual visits'. Binding: benefit-term (example, Coverage unit - annual, lifetime.); (xsd)term:CodeableConcept>?
[]< Benefits Used to date.; (xsd)financial:ExplanationOfBenefit.benefitBalance.financial>*🔗 Benefits Used to date.ExplanationOfBenefit.benefitBalance.financial(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Classification of benefit being provided. For example: deductible, visits, benefit amount. Binding: benefit-type (example, Deductable, visits, co-pay, etc.); (xsd)type:CodeableConcept>
< The quantity of the benefit which is permitted under the coverage.; (xsd)allowed:(<Money>
|<string>
|<unsignedInt>)>?
< The quantity of the benefit which have been consumed to date.; (xsd)used:(<Money>
|<unsignedInt>)>?🔗 The members of the team who provided the products and services.ExplanationOfBenefit.careTeam(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A number to uniquely identify care team entries.; (xsd)sequence:positiveInt>
< Member of the team who provided the product or service.; (xsd)provider:(<Organization>
|<Practitioner>
|<PractitionerRole>)>
< The party who is billing and/or responsible for the claimed products or services. Responsible might not be required when there is only a single provider listed.; (xsd)responsible:boolean>?
< The lead, assisting or supervising practitioner and their discipline if a multidisciplinary team. Role might not be required when there is only a single provider listed. Binding: claim-careteamrole (example, The role codes for the care team members.); (xsd)role:CodeableConcept>?
< The specialization of the practitioner or provider which is applicable for this service. Binding: provider-qualification (example, ); (xsd)specialty:CodeableConcept>?🔗 Information about diagnoses relevant to the claim items.ExplanationOfBenefit.diagnosis(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A number to uniquely identify diagnosis entries. Diagnosis are presented in list order to their expected importance: primary, secondary, etc.; (xsd)sequence:positiveInt>
< The nature of illness or problem in a coded form or as a reference to an external defined Condition. Binding: icd-10 (example, ICD10 Diagnostic codes.); (xsd)diagnosis:(<CodeableConcept>
|<Condition>)>
[]< When the condition was observed or the relative ranking. For example: admitting, primary, secondary, discharge. Binding: ex-diagnosistype (example, The type of the diagnosis: admitting, principal, discharge.); (xsd)type:CodeableConcept>*
< Indication of whether the diagnosis was present on admission to a facility. Binding: ex-diagnosis-on-admission (example, Present on admission.); (xsd)onAdmission:CodeableConcept>?🔗 Information code for an event with a corresponding date or period.ExplanationOfBenefit.event(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A coded event such as when a service is expected or a card printed. Binding: datestype (example, ); (xsd)type:CodeableConcept>
< A date or period in the past or future indicating when the event occurred or is expectd to occur.; (xsd)when:(<dateTime>
|<Period>)>🔗 Financial instruments for reimbursement for the health care products and services specified on the claim. All insurance coverages for the patient which may be applicable for reimbursement, of the products and services listed in the claim, are typically provided in the claim to allow insurers to confirm the ordering of the insurance coverages relative to local 'coordination of benefit' rules. One coverage (and only one) with 'focal=true' is to be used in the adjudication of this claim. Coverages appearing before the focal Coverage in the list, and where 'Coverage.subrogation=false', should provide a reference to the ClaimResponse containing the adjudication results of the prior claim.ExplanationOfBenefit.insurance(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A flag to indicate that this Coverage is to be used for adjudication of this claim when set to true. A patient may (will) have multiple insurance policies which provide reimbursement for healthcare services and products. For example, a person may also be covered by their spouse's policy and both appear in the list (and may be from the same insurer). This flag will be set to true for only one of the listed policies and that policy will be used for adjudicating this claim. Other claims would be created to request adjudication against the other listed policies.; (xsd)focal:boolean>
< Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system.; (xsd)coverage:Coverage*>
[]< Reference numbers previously provided by the insurer to the provider to be quoted on subsequent claims containing services or products related to the prior authorization. This value is an alphanumeric string that may be provided over the phone, via text, via paper, or within a ClaimResponse resource and is not a FHIR Identifier.; (xsd)preAuthRef:string>*🔗 A claim line. Either a simple (a product or service) or a 'group' of details which can also be a simple items or groups of sub-details.ExplanationOfBenefit.item(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A number to uniquely identify item entries.; (xsd)sequence:positiveInt>
[]< Care team members related to this service or product.; (xsd)careTeamSequence:positiveInt>*
[]< Diagnoses applicable for this service or product.; (xsd)diagnosisSequence:positiveInt>*
[]< Procedures applicable for this service or product.; (xsd)procedureSequence:positiveInt>*
[]< Exceptions, special conditions and supporting information applicable for this service or product.; (xsd)informationSequence:positiveInt>*
[]< Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners.; (xsd)traceNumber:Identifier>*
< The type of revenue or cost center providing the product and/or service. Binding: ex-revenue-center (example, Codes for the revenue or cost centers supplying the service and/or products.); (xsd)revenue:CodeableConcept>?
< Code to identify the general type of benefits under which products and services are provided. Examples include Medical Care, Periodontics, Renal Dialysis, Vision Coverage. Binding: ex-benefitcategory (example, Benefit categories such as: oral, medical, vision, oral-basic etc.); (xsd)category:CodeableConcept>?
< When the value is a group code then this item collects a set of related item details, otherwise this contains the product, service, drug or other billing code for the item. This element may be the start of a range of .productOrService codes used in conjunction with .productOrServiceEnd or it may be a solo element where .productOrServiceEnd is not used. If this is an actual service or product line, i.e. not a Group, then use code to indicate the Professional Service or Product supplied (e.g. CTP, HCPCS, USCLS, ICD10, NCPDP, DIN, RxNorm, ACHI, CCI). If a grouping item then use a group code to indicate the type of thing being grouped e.g. 'glasses' or 'compound'. Binding: service-uscls (example, Allowable service and product codes.); (xsd)productOrService:CodeableConcept>?
< This contains the end of a range of product, service, drug or other billing codes for the item. This element is not used when the .productOrService is a group code. This value may only be present when a .productOfService code has been provided to convey the start of the range. Typically this value may be used only with preauthorizations and not with claims. Binding: service-uscls (example, ); (xsd)productOrServiceEnd:CodeableConcept>?
[]< Request or Referral for Goods or Service to be rendered.; (xsd)request:(<DeviceRequest>
|<MedicationRequest>
|<NutritionOrder>
|<ServiceRequest>
|<SupplyRequest>
|<VisionPrescription>)>*
[]< Item typification or modifiers codes to convey additional context for the product or service. For example, in Oral whether the treatment is cosmetic or associated with TMJ, or for Medical whether the treatment was outside the clinic or out of office hours. Binding: claim-modifiers (example, Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.); (xsd)modifier:CodeableConcept>*
[]< Identifies the program under which this may be recovered. For example: Neonatal program, child dental program or drug users recovery program. Binding: ex-program-code (example, Program specific reason codes.); (xsd)programCode:CodeableConcept>*
< The date or dates when the service or product was supplied, performed or completed.; (xsd)serviced:(<date>
|<Period>)>?
< Where the product or service was provided. Binding: service-place (example, Place where the service is rendered.); (xsd)location:(<Address>
|<CodeableConcept>
|<Location>)>?
< The amount paid by the patient, in total at the claim claim level or specifically for the item and detail level, to the provider for goods and services.; (xsd)patientPaid:Money>?
< The number of repetitions of a service or product.; (xsd)quantity:SimpleQuantity>?
< If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.; (xsd)unitPrice:Money>?
< A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount. To show a 10% senior's discount, the value entered is: 0.90 (1.00 - 0.10).; (xsd)factor:decimal>?
< The total of taxes applicable for this product or service.; (xsd)tax:Money>?
< The total amount claimed for the group (if a grouper) or the line item. Net = unit price * quantity * factor. For example, the formula: quantity * unitPrice * factor = net. Quantity and factor are assumed to be 1 if not supplied.; (xsd)net:Money>?
[]< Unique Device Identifiers associated with this line item.; (xsd)udi:Device*>*
[]< Physical location where the service is performed or applies.; (xsd)bodySite:ExplanationOfBenefit.item.bodySite>*
[]< Healthcare encounters related to this claim.; (xsd)encounter:Encounter*>*
[]< The numbers associated with notes below which apply to the adjudication of this item.; (xsd)noteNumber:positiveInt>*
< The high-level results of the adjudication if adjudication has been performed.; (xsd)reviewOutcome:ExplanationOfBenefit.item.reviewOutcome>?
[]< If this item is a group then the values here are a summary of the adjudication of the detail items. If this item is a simple product or service then this is the result of the adjudication of this item.; (xsd)adjudication:ExplanationOfBenefit.item.adjudication>*
[]< Second-tier of goods and services.; (xsd)detail:ExplanationOfBenefit.item.detail>*🔗 If this item is a group then the values here are a summary of the adjudication of the detail items. If this item is a simple product or service then this is the result of the adjudication of this item.ExplanationOfBenefit.item.adjudication(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A code to indicate the information type of this adjudication record. Information types may include: the value submitted, maximum values or percentages allowed or payable under the plan, amounts that the patient is responsible for in-aggregate or pertaining to this item, amounts paid by other coverages, and the benefit payable for this item. For example, codes indicating: Co-Pay, deductible, eligible, benefit, tax, etc. Binding: adjudication (example, The adjudication codes.); (xsd)category:CodeableConcept>
< A code supporting the understanding of the adjudication result and explaining variance from expected amount. For example, may indicate that the funds for this benefit type have been exhausted. Binding: adjudication-reason (example, Adjudication reason codes.); (xsd)reason:CodeableConcept>?
< Monetary amount associated with the category. For example, amount submitted, eligible amount, co-payment, and benefit payable.; (xsd)amount:Money>?
< A non-monetary value associated with the category. Mutually exclusive to the amount element above. For example: eligible percentage or co-payment percentage.; (xsd)quantity:Quantity>?🔗 Physical location where the service is performed or applies.ExplanationOfBenefit.item.bodySite(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< Physical service site on the patient (limb, tooth, etc.). For example: Providing a tooth code, allows an insurer to identify a provider performing a filling on a tooth that was previously removed. Binding: tooth (example, ); (xsd)site:BodyStructure*>+
[]< A region or surface of the bodySite, e.g. limb region or tooth surface(s). Binding: surface (example, ); (xsd)subSite:CodeableConcept>*🔗 Second-tier of goods and services.ExplanationOfBenefit.item.detail(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A claim detail line. Either a simple (a product or service) or a 'group' of sub-details which are simple items.; (xsd)sequence:positiveInt>
[]< Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners.; (xsd)traceNumber:Identifier>*
< The type of revenue or cost center providing the product and/or service. Binding: ex-revenue-center (example, Codes for the revenue or cost centers supplying the service and/or products.); (xsd)revenue:CodeableConcept>?
< Code to identify the general type of benefits under which products and services are provided. Examples include: Medical Care, Periodontics, Renal Dialysis, Vision Coverage. Binding: ex-benefitcategory (example, Benefit categories such as: oral, medical, vision, oral-basic etc.); (xsd)category:CodeableConcept>?
< When the value is a group code then this item collects a set of related item details, otherwise this contains the product, service, drug or other billing code for the item. This element may be the start of a range of .productOrService codes used in conjunction with .productOrServiceEnd or it may be a solo element where .productOrServiceEnd is not used. If this is an actual service or product line, i.e. not a Group, then use code to indicate the Professional Service or Product supplied (e.g. CTP, HCPCS, USCLS, ICD10, NCPDP, DIN, RxNorm, ACHI, CCI). If a grouping item then use a group code to indicate the type of thing being grouped e.g. 'glasses' or 'compound'. Binding: service-uscls (example, Allowable service and product codes.); (xsd)productOrService:CodeableConcept>?
< This contains the end of a range of product, service, drug or other billing codes for the item. This element is not used when the .productOrService is a group code. This value may only be present when a .productOfService code has been provided to convey the start of the range. Typically this value may be used only with preauthorizations and not with claims. Binding: service-uscls (example, ); (xsd)productOrServiceEnd:CodeableConcept>?
[]< Item typification or modifiers codes to convey additional context for the product or service. For example, in Oral whether the treatment is cosmetic or associated with TMJ, or for Medical whether the treatment was outside the clinic or out of office hours. Binding: claim-modifiers (example, Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.); (xsd)modifier:CodeableConcept>*
[]< Identifies the program under which this may be recovered. For example: Neonatal program, child dental program or drug users recovery program. Binding: ex-program-code (example, Program specific reason codes.); (xsd)programCode:CodeableConcept>*
< The amount paid by the patient, in total at the claim claim level or specifically for the item and detail level, to the provider for goods and services.; (xsd)patientPaid:Money>?
< The number of repetitions of a service or product.; (xsd)quantity:SimpleQuantity>?
< If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.; (xsd)unitPrice:Money>?
< A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount. To show a 10% senior's discount, the value entered is: 0.90 (1.00 - 0.10).; (xsd)factor:decimal>?
< The total of taxes applicable for this product or service.; (xsd)tax:Money>?
< The total amount claimed for the group (if a grouper) or the line item.detail. Net = unit price * quantity * factor. For example, the formula: quantity * unitPrice * factor = net. Quantity and factor are assumed to be 1 if not supplied.; (xsd)net:Money>?
[]< Unique Device Identifiers associated with this line item.; (xsd)udi:Device*>*
[]< The numbers associated with notes below which apply to the adjudication of this item.; (xsd)noteNumber:positiveInt>*
< The high-level results of the adjudication if adjudication has been performed.; (xsd)reviewOutcome:ExplanationOfBenefit.item.reviewOutcome>?
[]< The adjudication results.; (xsd)adjudication:ExplanationOfBenefit.item.adjudication>*
[]< Third-tier of goods and services.; (xsd)subDetail:ExplanationOfBenefit.item.detail.subDetail>*🔗 Third-tier of goods and services.ExplanationOfBenefit.item.detail.subDetail(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A claim detail line. Either a simple (a product or service) or a 'group' of sub-details which are simple items.; (xsd)sequence:positiveInt>
[]< Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners.; (xsd)traceNumber:Identifier>*
< The type of revenue or cost center providing the product and/or service. Binding: ex-revenue-center (example, Codes for the revenue or cost centers supplying the service and/or products.); (xsd)revenue:CodeableConcept>?
< Code to identify the general type of benefits under which products and services are provided. Examples include Medical Care, Periodontics, Renal Dialysis, Vision Coverage. Binding: ex-benefitcategory (example, Benefit categories such as: oral, medical, vision, oral-basic etc.); (xsd)category:CodeableConcept>?
< When the value is a group code then this item collects a set of related item details, otherwise this contains the product, service, drug or other billing code for the item. This element may be the start of a range of .productOrService codes used in conjunction with .productOrServiceEnd or it may be a solo element where .productOrServiceEnd is not used. If this is an actual service or product line, i.e. not a Group, then use code to indicate the Professional Service or Product supplied (e.g. CTP, HCPCS, USCLS, ICD10, NCPDP, DIN, RxNorm, ACHI, CCI). If a grouping item then use a group code to indicate the type of thing being grouped e.g. 'glasses' or 'compound'. Binding: service-uscls (example, Allowable service and product codes.); (xsd)productOrService:CodeableConcept>?
< This contains the end of a range of product, service, drug or other billing codes for the item. This element is not used when the .productOrService is a group code. This value may only be present when a .productOfService code has been provided to convey the start of the range. Typically this value may be used only with preauthorizations and not with claims. Binding: service-uscls (example, ); (xsd)productOrServiceEnd:CodeableConcept>?
[]< Item typification or modifiers codes to convey additional context for the product or service. For example, in Oral whether the treatment is cosmetic or associated with TMJ, or for Medical whether the treatment was outside the clinic or outside of office hours. Binding: claim-modifiers (example, Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.); (xsd)modifier:CodeableConcept>*
[]< Identifies the program under which this may be recovered. For example: Neonatal program, child dental program or drug users recovery program. Binding: ex-program-code (example, Program specific reason codes.); (xsd)programCode:CodeableConcept>*
< The amount paid by the patient, in total at the claim claim level or specifically for the item and detail level, to the provider for goods and services.; (xsd)patientPaid:Money>?
< The number of repetitions of a service or product.; (xsd)quantity:SimpleQuantity>?
< If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.; (xsd)unitPrice:Money>?
< A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount. To show a 10% senior's discount, the value entered is: 0.90 (1.00 - 0.10).; (xsd)factor:decimal>?
< The total of taxes applicable for this product or service.; (xsd)tax:Money>?
< The total amount claimed for the line item.detail.subDetail. Net = unit price * quantity * factor. For example, the formula: quantity * unitPrice * factor = net. Quantity and factor are assumed to be 1 if not supplied.; (xsd)net:Money>?
[]< Unique Device Identifiers associated with this line item.; (xsd)udi:Device*>*
[]< The numbers associated with notes below which apply to the adjudication of this item.; (xsd)noteNumber:positiveInt>*
< The high-level results of the adjudication if adjudication has been performed.; (xsd)reviewOutcome:ExplanationOfBenefit.item.reviewOutcome>?
[]< The adjudication results.; (xsd)adjudication:ExplanationOfBenefit.item.adjudication>*🔗 The high-level results of the adjudication if adjudication has been performed.ExplanationOfBenefit.item.reviewOutcome(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The result of the claim, predetermination, or preauthorization adjudication. The element is used to indicate the current state of the adjudication overall for the claim resource, for example: the request has been held (pended) for adjudication processing, for manual review or other reasons; that it has been processed and will be paid, or the outstanding paid, as submitted (approved); that no amount will be paid (denied); or that some amount between zero and the submitted amount will be paid (partial). Binding: claim-decision (example, ); (xsd)decision:CodeableConcept>?
[]< The reasons for the result of the claim, predetermination, or preauthorization adjudication. Binding: claim-decision-reason (example, ); (xsd)reason:CodeableConcept>*
< Reference from the Insurer which is used in later communications which refers to this adjudication. This value is only present on preauthorization adjudications.; (xsd)preAuthRef:string>?
< The time frame during which this authorization is effective.; (xsd)preAuthPeriod:Period>?🔗 The party to be reimbursed for cost of the products and services according to the terms of the policy. Often providers agree to receive the benefits payable to reduce the near-term costs to the patient. The insurer may decline to pay the provider and may choose to pay the subscriber instead.ExplanationOfBenefit.payee(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Type of Party to be reimbursed: Subscriber, provider, other. Binding: payeetype (example, A code for the party to be reimbursed.); (xsd)type:CodeableConcept>?
< Reference to the individual or organization to whom any payment will be made. Not required if the payee is 'subscriber' or 'provider'.; (xsd)party:(<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>?🔗 Payment details for the adjudication of the claim.ExplanationOfBenefit.payment(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Whether this represents partial or complete payment of the benefits payable. Binding: ex-paymenttype (example, The type (partial, complete) of the payment.); (xsd)type:CodeableConcept>?
< Total amount of all adjustments to this payment included in this transaction which are not related to this claim's adjudication. Insurers will deduct amounts owing from the provider (adjustment), such as a prior overpayment, from the amount owing to the provider (benefits payable) when payment is made to the provider.; (xsd)adjustment:Money>?
< Reason for the payment adjustment. Binding: payment-adjustment-reason (example, Payment Adjustment reason codes.); (xsd)adjustmentReason:CodeableConcept>?
< Estimated date the payment will be issued or the actual issue date of payment.; (xsd)date>?
< Benefits payable less any payment adjustment.; (xsd)amount:Money>?
< Issuer's unique identifier for the payment instrument. For example: EFT number or check number.; (xsd)identifier:Identifier>?🔗 Procedures performed on the patient relevant to the billing items with the claim.ExplanationOfBenefit.procedure(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A number to uniquely identify procedure entries.; (xsd)sequence:positiveInt>
[]< When the condition was observed or the relative ranking. Binding: ex-procedure-type (example, Example procedure type codes.); (xsd)type:CodeableConcept>*
< Date and optionally time the procedure was performed.; (xsd)date:dateTime>?
< The code or reference to a Procedure resource which identifies the clinical intervention performed. Binding: icd-10-procedures (example, ICD10 Procedure codes.); (xsd)procedure:(<CodeableConcept>
|<Procedure>)>
[]< Unique Device Identifiers associated with this line item.; (xsd)udi:Device*>*🔗 A note that describes or explains adjudication results in a human readable form.ExplanationOfBenefit.processNote(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A number to uniquely identify a note entry.; (xsd)number:positiveInt>?
< The business purpose of the note text. Binding: note-type (extensible, The presentation types of notes.); (xsd)type:CodeableConcept>?
< The explanation or description associated with the processing.; (xsd)text:string>?
< A code to define the language used in the text of the note. Only required if the language is different from the resource language. Binding: all-languages (required, IETF language tag for a human language); (xsd)language:CodeableConcept>?🔗 Other claims which are related to this claim such as prior submissions or claims for related services or for the same event. For example, for the original treatment and follow-up exams.ExplanationOfBenefit.related(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Reference to a related claim.; (xsd)claim:Claim*>?
< A code to convey how the claims are related. For example, prior claim or umbrella. Binding: related-claim-relationship (example, Relationship of this claim to a related Claim.); (xsd)relationship:CodeableConcept>?
< An alternate organizational reference to the case or file to which this particular claim pertains. For example, Property/Casualty insurer claim number or Workers Compensation case number.; (xsd)reference:Identifier>?🔗 Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues. Often there are multiple jurisdiction specific valuesets which are required.ExplanationOfBenefit.supportingInfo(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A number to uniquely identify supporting information entries.; (xsd)sequence:positiveInt>
< The general class of the information supplied: information; exception; accident, employment; onset, etc. This may contain a category for the local bill type codes. Binding: claim-informationcategory (example, The valuset used for additional information category codes.); (xsd)category:CodeableConcept>
< System and code pertaining to the specific information regarding special conditions relating to the setting, treatment or patient for which care is sought. This may contain the local bill type codes such as the US UB-04 bill type code. Binding: claim-exception (example, The valuset used for additional information codes.); (xsd)code:CodeableConcept>?
< The date when or period to which this information refers.; (xsd)timing:(<date>
|<Period>)>?
(<valueAttachment:Attachment>
|<valueBoolean:boolean>
|<valueIdentifier:Identifier>
|<valueQuantity:Quantity>
|<valueResource:Resource>
|<valueString:string>)?
< Provides the reason in the situation where a reason code is required in addition to the content. For example: the reason for the additional stay, or why a tooth is missing. Binding: missing-tooth-reason (example, Reason codes for the missing teeth.); (xsd)reason:Coding>?🔗 Categorized monetary totals for the adjudication. Totals for amounts submitted, co-pays, benefits payable etc.ExplanationOfBenefit.total(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A code to indicate the information type of this adjudication record. Information types may include: the value submitted, maximum values or percentages allowed or payable under the plan, amounts that the patient is responsible for in aggregate or pertaining to this item, amounts paid by other coverages, and the benefit payable for this item. For example, codes indicating: Co-Pay, deductible, eligible, benefit, tax, etc. Binding: adjudication (example, The adjudication codes.); (xsd)category:CodeableConcept>
< Monetary total amount associated with the category.; (xsd)amount:Money>🔗 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(xsd)(doc)=
<#base:DataType>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< A brief, natural language description of the condition that effectively communicates the intended semantics.; (xsd)description:string>?
< A short name assigned to the expression to allow for multiple reuse of the expression in the context where it is defined.; (xsd)name:code>?
< The media type of the language for the expression. Binding: expression-language (extensible, The media type of the expression language.); (xsd)language:code>?
< An expression in the specified language that returns a value. If Expression.expression and Expression.reference are both present, the Expression.expression might just be a name pointing something within the referenced content.; (xsd)expression:string>?
< 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.; (xsd)reference:uri>?🔗 Specifies contact information for a specific purpose over a period of time, might be handled/monitored by a specific named person or organization. This datatype may be sparsely populated, i.e. only contain a purpose and phone number or address, but other cases could be completed filled out.ExtendedContactDetail(xsd)(doc)=
<#base:DataType>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< The purpose/type of contact. If no purpose is defined, then these contact details may be used for any purpose. Binding: http://terminology.hl7.org/ValueSet/contactentity-type (preferred, The purpose for which an extended contact detail should be used.); (xsd)purpose:CodeableConcept>?
[]< The name of an individual to contact, some types of contact detail are usually blank. If there is no named individual, the telecom/address information is not generally monitored by a specific individual.; (xsd)name:HumanName>*
[]< The contact details application for the purpose defined.; (xsd)telecom:ContactPoint>*
< Address for the contact. More than 1 address would be for different purposes, and thus should be entered as a different entry,.; (xsd)address:Address>?
< This contact detail is handled/monitored by a specific organization. If the name is provided in the contact, then it is referring to the named individual within this organization.; (xsd)organization:Organization*>?
< Period that this contact was valid for usage. If the details have multiple periods, then enter in a new ExtendedContact with the new period.; (xsd)period:Period>?🔗 Optional Extension Element - found in all resources.Extension(xsd)(doc)=
<#base:DataType>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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.; (xsd)url:string>
(<valueAddress:Address>
|<valueAge:Age>
|<valueAnnotation:Annotation>
|<valueAttachment:Attachment>
|<valueAvailability:Availability>
|<valueBase64Binary:base64Binary>
|<valueBoolean:boolean>
|<valueCode:code>
|<valueCodeableConcept:CodeableConcept>
|<valueCoding:Coding>
|<valueContactDetail:ContactDetail>
|<valueContactPoint:ContactPoint>
|<valueCount:Count>
|<valueDataRequirement:DataRequirement>
|<valueDate:date>
|<valueDateTime:dateTime>
|<valueDecimal:decimal>
|<valueDistance:Distance>
|<valueDosage:Dosage>
|<valueDuration:Duration>
|<valueExpression:Expression>
|<valueExtendedContactDetail:ExtendedContactDetail>
|<valueHumanName:HumanName>
|<valueId:id>
|<valueIdentifier:Identifier>
|<valueInstant:instant>
|<valueInteger:integer>
|<valueInteger64:integer64>
|<valueMarkdown:markdown>
|<valueMeta:Meta>
|<valueMoney:Money>
|<valueOid:oid>
|<valueParameterDefinition:ParameterDefinition>
|<valuePeriod:Period>
|<valuePositiveInt:positiveInt>
|<valueQuantity:Quantity>
|<valueRange:Range>
|<valueRatio:Ratio>
|<valueRatioRange:RatioRange>
|<valueRelatedArtifact:RelatedArtifact>
|<valueResource:Resource>
|<valueSampledData:SampledData>
|<valueSignature:Signature>
|<valueString:string>
|<valueTime:time>
|<valueTiming:Timing>
|<valueTriggerDefinition:TriggerDefinition>
|<valueUnsignedInt:unsignedInt>
|<valueUri:uri>
|<valueUrl:url>
|<valueUsageContext:UsageContext>
|<valueUuid:uuid>)?🔗 Significant health conditions for a person related to the patient relevant in the context of care for the patient.FamilyMemberHistory(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< Business identifiers assigned to this family member history by the performer or other systems which remain constant as the resource is updated and propagates from server to server. This is a business identifier, not a resource identifier (see [discussion](resource.html#identifiers)). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.; (xsd)identifier:Identifier>*
[]< The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory.; (xsd)instantiatesCanonical:(<ActivityDefinition>
|<Measure>
|<OperationDefinition>
|<PlanDefinition>
|<Questionnaire>)>*
[]< The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory. This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.; (xsd)instantiatesUri:uri>*
< A code specifying the status of the record of the family history of a specific family member. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. Binding: history-status (required, A code that identifies the status of the family history record.); (xsd)status:code>
< Describes why the family member's history is not available. Binding: history-absent-reason (example, Codes describing the reason why a family member's history is not available.); (xsd)dataAbsentReason:CodeableConcept>?
< The person who this history concerns. This is not the family member.; (xsd)patient:Patient*>
< The date (and possibly time) when the family member history was recorded or last updated. This should be captured even if the same as the date on the List aggregating the full family history.; (xsd)date:dateTime>?
[]< Indicates who or what participated in the activities related to the family member history and how they were involved.; (xsd)participant:FamilyMemberHistory.participant>*
< This will either be a name or a description; e.g. "Aunt Susan", "my cousin with the red hair".; (xsd)name:string>?
< The type of relationship this person has to the patient (father, mother, brother etc.). Binding: http://terminology.hl7.org/ValueSet/v3-FamilyMember (example, The nature of the relationship between the patient and the related person being described in the family member history.); (xsd)relationship:CodeableConcept>
< The birth sex of the family member. This element should ideally reflect whether the individual is genetically male or female. However, as reported information based on the knowledge of the patient or reporting friend/relative, there may be situations where the reported sex might not be totally accurate. E.g. 'Aunt Sue' might be XY rather than XX. Questions soliciting this information should be phrased to encourage capture of genetic sex where known. However, systems performing analysis should also allow for the possibility of imprecision with this element. Binding: administrative-gender (extensible, Codes describing the sex assigned at birth as documented on the birth registration.); (xsd)sex:CodeableConcept>?
< The actual or approximate date of birth of the relative.; (xsd)born:(<date>
|<Period>
|<string>)>?
< The age of the relative at the time the family member history is recorded. use estimatedAge to indicate whether the age is actual or not.; (xsd)age:(<Age>
|<Range>
|<string>)>?
< If true, indicates that the age value specified is an estimated value. This element is labeled as a modifier because the fact that age is estimated can/should change the results of any algorithm that calculates based on the specified age.; (xsd)estimatedAge:boolean>?
< Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.; (xsd)deceased:(<Age>
|<boolean>
|<date>
|<Range>
|<string>)>?
[]< Describes why the family member history occurred in coded or textual form, or Indicates a Condition, Observation, AllergyIntolerance, or QuestionnaireResponse that justifies this family member history event. Textual reasons can be captured using reasonCode.text. Binding: clinical-findings (example, Codes indicating why the family member history was done.); (xsd)reason:(<AllergyIntolerance>
|<Condition>
|<DiagnosticReport>
|<DocumentReference>
|<Observation>
|<QuestionnaireResponse>)>*
[]< This property allows a non condition-specific note to the made about the related person. Ideally, the note would be in the condition property, but this is not always possible.; (xsd)note:Annotation>*
[]< The significant Conditions (or condition) that the family member had. This is a repeating section to allow a system to represent more than one condition per resource, though there is nothing stopping multiple resources - one per condition.; (xsd)condition:FamilyMemberHistory.condition>*
[]< The significant Procedures (or procedure) that the family member had. This is a repeating section to allow a system to represent more than one procedure per resource, though there is nothing stopping multiple resources - one per procedure.; (xsd)procedure:FamilyMemberHistory.procedure>*🔗 The significant Conditions (or condition) that the family member had. This is a repeating section to allow a system to represent more than one condition per resource, though there is nothing stopping multiple resources - one per condition.FamilyMemberHistory.condition(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The actual condition specified. Could be a coded condition (like MI or Diabetes) or a less specific string like 'cancer' depending on how much is known about the condition and the capabilities of the creating system. Binding: condition-code (example, Identification of the Condition or diagnosis.); (xsd)code:CodeableConcept>
< Indicates what happened following the condition. If the condition resulted in death, deceased date is captured on the relation. Binding: condition-outcome (example, The result of the condition for the patient; e.g. death, permanent disability, temporary disability, etc.); (xsd)outcome:CodeableConcept>?
< This condition contributed to the cause of death of the related person. If contributedToDeath is not populated, then it is unknown.; (xsd)contributedToDeath:boolean>?
< Either the age of onset, range of approximate age or descriptive string can be recorded. For conditions with multiple occurrences, this describes the first known occurrence.; (xsd)onset:(<Age>
|<Period>
|<Range>
|<string>)>?
[]< An area where general notes can be placed about this specific condition.; (xsd)note:Annotation>*🔗 Indicates who or what participated in the activities related to the family member history and how they were involved.FamilyMemberHistory.participant(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Distinguishes the type of involvement of the actor in the activities related to the family member history. Binding: participation-role-type (extensible, ); (xsd)function:CodeableConcept>?
< Indicates who or what participated in the activities related to the family member history.; (xsd)actor:(<CareTeam>
|<Device>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>🔗 The significant Procedures (or procedure) that the family member had. This is a repeating section to allow a system to represent more than one procedure per resource, though there is nothing stopping multiple resources - one per procedure.FamilyMemberHistory.procedure(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The actual procedure specified. Could be a coded procedure or a less specific string depending on how much is known about the procedure and the capabilities of the creating system. Binding: procedure-code (example, A code to identify a specific procedure.); (xsd)code:CodeableConcept>
< Indicates what happened following the procedure. If the procedure resulted in death, deceased date is captured on the relation. Binding: clinical-findings (example, The result of the procedure; e.g. death, permanent disability, temporary disability, etc.); (xsd)outcome:CodeableConcept>?
< This procedure contributed to the cause of death of the related person. If contributedToDeath is not populated, then it is unknown.; (xsd)contributedToDeath:boolean>?
< Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.; (xsd)performed:(<Age>
|<dateTime>
|<Period>
|<Range>
|<string>)>?
[]< An area where general notes can be placed about this specific procedure.; (xsd)note:Annotation>*🔗 Significant health conditions for a person related to the patient relevant in the context of care for the patient.familymemberhistory-genetic(xsd)(doc)=
<#base:FamilyMemberHistory>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< An Extension; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< Business identifiers assigned to this family member history by the performer or other systems which remain constant as the resource is updated and propagates from server to server. This is a business identifier, not a resource identifier (see [discussion](resource.html#identifiers)). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.; (xsd)identifier:Identifier>*
[]< The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory.; (xsd)instantiatesCanonical:(<ActivityDefinition>
|<Measure>
|<OperationDefinition>
|<PlanDefinition>
|<Questionnaire>)>*
[]< The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory. This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.; (xsd)instantiatesUri:uri>*
< A code specifying the status of the record of the family history of a specific family member. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. Binding: history-status (required, A code that identifies the status of the family history record.); (xsd)status:code>
< Describes why the family member's history is not available. Binding: history-absent-reason (example, Codes describing the reason why a family member's history is not available.); (xsd)dataAbsentReason:CodeableConcept>?
< The person who this history concerns. This is not the family member.; (xsd)patient:Patient*>
< The date (and possibly time) when the family member history was recorded or last updated. This should be captured even if the same as the date on the List aggregating the full family history.; (xsd)date:dateTime>?
[]< Indicates who or what participated in the activities related to the family member history and how they were involved.; (xsd)participant:familymemberhistory-genetic.participant>*
< This will either be a name or a description; e.g. "Aunt Susan", "my cousin with the red hair".; (xsd)name:string>?
< The type of relationship this person has to the patient (father, mother, brother etc.). Binding: http://terminology.hl7.org/ValueSet/v3-FamilyMember (example, The nature of the relationship between the patient and the related person being described in the family member history.); (xsd)relationship:CodeableConcept>
< The birth sex of the family member. This element should ideally reflect whether the individual is genetically male or female. However, as reported information based on the knowledge of the patient or reporting friend/relative, there may be situations where the reported sex might not be totally accurate. E.g. 'Aunt Sue' might be XY rather than XX. Questions soliciting this information should be phrased to encourage capture of genetic sex where known. However, systems performing analysis should also allow for the possibility of imprecision with this element. Binding: administrative-gender (extensible, Codes describing the sex assigned at birth as documented on the birth registration.); (xsd)sex:CodeableConcept>?
< The actual or approximate date of birth of the relative.; (xsd)born:(<date>
|<Period>
|<string>)>?
< The age of the relative at the time the family member history is recorded. use estimatedAge to indicate whether the age is actual or not.; (xsd)age:(<Age>
|<Range>
|<string>)>?
< If true, indicates that the age value specified is an estimated value. This element is labeled as a modifier because the fact that age is estimated can/should change the results of any algorithm that calculates based on the specified age.; (xsd)estimatedAge:boolean>?
< Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.; (xsd)deceased:(<Age>
|<boolean>
|<date>
|<Range>
|<string>)>?
[]< Describes why the family member history occurred in coded or textual form, or Indicates a Condition, Observation, AllergyIntolerance, or QuestionnaireResponse that justifies this family member history event. Textual reasons can be captured using reasonCode.text. Binding: clinical-findings (example, Codes indicating why the family member history was done.); (xsd)reason:(<AllergyIntolerance>
|<Condition>
|<DiagnosticReport>
|<DocumentReference>
|<Observation>
|<QuestionnaireResponse>)>*
[]< This property allows a non condition-specific note to the made about the related person. Ideally, the note would be in the condition property, but this is not always possible.; (xsd)note:Annotation>*
[]< The significant Conditions (or condition) that the family member had. This is a repeating section to allow a system to represent more than one condition per resource, though there is nothing stopping multiple resources - one per condition.; (xsd)condition:familymemberhistory-genetic.condition>*
[]< The significant Procedures (or procedure) that the family member had. This is a repeating section to allow a system to represent more than one procedure per resource, though there is nothing stopping multiple resources - one per procedure.; (xsd)procedure:familymemberhistory-genetic.procedure>*
[]< Identifies a parent of the relative. Some individuals may have more than two parents (e.g. genetic vs. adoptive parents). Even non-genetic relationships can be relevant in terms of genetic exposure.; (xsd)parent:Extension>*
[]< Identifies a sibling of the relative. Some cases may have complex inner-pedigree-tree relationship. For instance, double cousin relationship need two extra link with In pedigree tree itself. This can't be revealed by relationship to subject.; (xsd)sibling:Extension>*
[]< Allows capturing risk-relevant observations about the relative that aren't themselves a specific health condition; e.g. Certain ethnic ancestries that are disease-relevant, presence of particular genetic markers, etc. This may be extended with additional genomics-specific resources when they are ready.; (xsd)observations:Extension>*🔗 The significant Conditions (or condition) that the family member had. This is a repeating section to allow a system to represent more than one condition per resource, though there is nothing stopping multiple resources - one per condition.familymemberhistory-genetic.condition(xsd)(doc)=
<#base:FamilyMemberHistory.condition>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The actual condition specified. Could be a coded condition (like MI or Diabetes) or a less specific string like 'cancer' depending on how much is known about the condition and the capabilities of the creating system. Binding: condition-code (example, Identification of the Condition or diagnosis.); (xsd)code:CodeableConcept>
< Indicates what happened following the condition. If the condition resulted in death, deceased date is captured on the relation. Binding: condition-outcome (example, The result of the condition for the patient; e.g. death, permanent disability, temporary disability, etc.); (xsd)outcome:CodeableConcept>?
< This condition contributed to the cause of death of the related person. If contributedToDeath is not populated, then it is unknown.; (xsd)contributedToDeath:boolean>?
< Either the age of onset, range of approximate age or descriptive string can be recorded. For conditions with multiple occurrences, this describes the first known occurrence.; (xsd)onset:(<Age>
|<Period>
|<Range>
|<string>)>?
[]< An area where general notes can be placed about this specific condition.; (xsd)note:Annotation>*🔗 Indicates who or what participated in the activities related to the family member history and how they were involved.familymemberhistory-genetic.participant(xsd)(doc)=
<#base:FamilyMemberHistory.participant>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Distinguishes the type of involvement of the actor in the activities related to the family member history. Binding: participation-role-type (extensible, ); (xsd)function:CodeableConcept>?
< Indicates who or what participated in the activities related to the family member history.; (xsd)actor:(<CareTeam>
|<Device>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>🔗 The significant Procedures (or procedure) that the family member had. This is a repeating section to allow a system to represent more than one procedure per resource, though there is nothing stopping multiple resources - one per procedure.familymemberhistory-genetic.procedure(xsd)(doc)=
<#base:FamilyMemberHistory.procedure>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The actual procedure specified. Could be a coded procedure or a less specific string depending on how much is known about the procedure and the capabilities of the creating system. Binding: procedure-code (example, A code to identify a specific procedure.); (xsd)code:CodeableConcept>
< Indicates what happened following the procedure. If the procedure resulted in death, deceased date is captured on the relation. Binding: clinical-findings (example, The result of the procedure; e.g. death, permanent disability, temporary disability, etc.); (xsd)outcome:CodeableConcept>?
< This procedure contributed to the cause of death of the related person. If contributedToDeath is not populated, then it is unknown.; (xsd)contributedToDeath:boolean>?
< Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.; (xsd)performed:(<Age>
|<dateTime>
|<Period>
|<Range>
|<string>)>?
[]< An area where general notes can be placed about this specific procedure.; (xsd)note:Annotation>*🔗 The Library resource is a general-purpose container for knowledge asset definitions. It can be used to describe and expose existing knowledge assets such as logic libraries and information model descriptions, as well as to describe a collection of knowledge assets.fhirpathlibrary(xsd)(doc)=
<#base:logiclibrary>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< An Extension; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< An absolute URI that is used to identify this library when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this library is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the library is stored on different servers. Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.
The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions).
In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.; (xsd)url:uri>
[]< A formal identifier that is used to identify this library when it is represented in other formats, or referenced in a specification, model, design or an instance. e.g. CMS or NQF identifiers for a measure artifact. Note that at least one identifier is required for non-experimental active artifacts. Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this library outside of FHIR, where it is not possible to use the logical URI.; (xsd)identifier:Identifier>*
< The identifier that is used to identify this version of the library when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the library author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts. There may be different library instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the library with the format [url]|[version]. The version SHOULD NOT contain a '#' - see [Business Version](resource.html#bv-format).; (xsd)version:string>
< Indicates the mechanism used to compare versions to determine which is more current. If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined. Binding: version-algorithm (extensible, ); (xsd)versionAlgorithm:(<Coding>
|<string>)>?
< A natural language name identifying the library. This name should be usable as an identifier for the module by machine processing applications such as code generation. The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.; (xsd)name:string>?
< A short, descriptive, user-friendly title for the library. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.; (xsd)title:string>
< An explanatory or alternate title for the library giving additional information about its content.; (xsd)subtitle:string>?
< The status of this library. Enables tracking the life-cycle of the content. Allows filtering of libraries that are appropriate for use vs. not.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization). Binding: publication-status (required, The lifecycle status of an artifact.); (xsd)status:code>
< A Boolean value to indicate that this library is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. Allows filtering of librarys that are appropriate for use versus not.; (xsd)experimental:boolean>?
< Identifies the type of library such as a Logic Library, Model Definition, Asset Collection, or Module Definition. Binding: library-type (extensible, The type of knowledge asset this library contains.); (xsd)type:CodeableConcept>
< A code or group definition that describes the intended subject of the contents of the library. Binding: participant-resource-types (extensible, The possible types of subjects for a library (E.g. Patient, Practitioner, Organization, Location, etc.).); (xsd)subject:(<CodeableConcept>
|<Group>)>?
< The date (and optionally time) when the library was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the library changes. The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the library. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)date:dateTime>?
< The name of the organization or individual responsible for the release and ongoing maintenance of the library. Usually an organization but may be an individual. The publisher (or steward) of the library is the organization or individual primarily responsible for the maintenance and upkeep of the library. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the library. This item SHOULD be populated unless the information is available from context.; (xsd)publisher:string>?
[]< Contact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)contact:ContactDetail>*
< A free text natural language description of the library from a consumer's perspective. This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the library as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the library is presumed to be the predominant language in the place the library was created).; (xsd)description:markdown>
[]< The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate library instances. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.; (xsd)useContext:UsageContext>*
[]< A legal or geographic region in which the library is intended to be used. It may be possible for the library to be used in jurisdictions other than those for which it was originally designed or intended.
DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.) Binding: jurisdiction (extensible, Countries and regions within which this artifact is targeted for use.); (xsd)jurisdiction:CodeableConcept>*
< Explanation of why this library is needed and why it has been designed as it has. This element does not describe the usage of the library. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this library.; (xsd)purpose:markdown>?
< A detailed description of how the library is used from a clinical perspective.; (xsd)usage:markdown>?
< A copyright statement relating to the library and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the library. The short copyright declaration (e.g. (c) '2015+ xyz organization' should be sent in the copyrightLabel element.; (xsd)copyright:markdown>?
< A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved'). The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.; (xsd)copyrightLabel:string>?
< The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)approvalDate:date>?
< The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. If specified, this date follows the original approval date.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)lastReviewDate:date>?
< The period during which the library content was or is planned to be in active use. The effective period for a library determines when the content is applicable for usage and is independent of publication and review dates. For example, a library intended to be used for the year 2016 might be published in 2015.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)effectivePeriod:Period>?
[]< Descriptive topics related to the content of the library. Topics provide a high-level categorization of the library that can be useful for filtering and searching. DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'topic' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#topic and useContext.valueCodeableConcept indicating the topic) Binding: definition-topic (example, High-level categorization of the definition, used for searching, sorting, and filtering.); (xsd)topic:CodeableConcept>*
[]< An individiual or organization primarily involved in the creation and maintenance of the content.; (xsd)author:ContactDetail>*
[]< An individual or organization primarily responsible for internal coherence of the content.; (xsd)editor:ContactDetail>*
[]< An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the content. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)reviewer:ContactDetail>*
[]< An individual or organization asserted by the publisher to be responsible for officially endorsing the content for use in some setting. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)endorser:ContactDetail>*
[]< Related artifacts such as additional documentation, justification, or bibliographic references. Each related artifact is either an attachment, or a reference to another resource, but not both.; (xsd)relatedArtifact:RelatedArtifact>*
[]< The parameter element defines parameters used by the library.; (xsd)parameter:ParameterDefinition>*
[]< Describes a set of data that must be provided in order to be able to successfully perform the computations defined by the library.; (xsd)dataRequirement:DataRequirement>*
[]< The content of the library as an Attachment. The content may be a reference to a url, or may be directly embedded as a base-64 string. Either way, the contentType of the attachment determines how to interpret the content.; (xsd)content:fhirpathlibrary.content>*
[]< Defines a knowledge capability afforded by this knowledge artifact.; (xsd)knowledgeCapability:Extension>*
[]< Defines a knowledge representation level provided by this knowledge artifact.; (xsd)knowledgeRepresentationLevel:Extension>*
[]< A comment containing additional documentation, a review comment, usage guidance, or other relevant information from a particular user.; (xsd)artifactComment:Extension>*
[]< Defines a code directly referenced by artifact logic, as opposed to a value set. Direct reference codes may be the target of data requirements.; (xsd)directReferenceCode:Extension>*
[]< Related artifacts such as additional documentation, justification, or bibliographic references. Each related artifact is either an attachment, or a reference to another resource, but not both.; (xsd)dependency:fhirpathlibrary.dependency>*
[]< The FHIRPath content represented as base-64 encoded data.; (xsd)fhirPathContent:fhirpathlibrary.fhirPathContent>+🔗 The content of the library as an Attachment. The content may be a reference to a url, or may be directly embedded as a base-64 string. Either way, the contentType of the attachment determines how to interpret the content.fhirpathlibrary.content(xsd)(doc)=
<#base:logiclibrary.content>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< 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. Binding: mimetypes (required, BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)); (xsd)contentType:code>?
< The human language of the content. The value can be any valid value according to BCP 47. Binding: all-languages (required, IETF language tag for a human language.); (xsd)language:code>?
< 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.; (xsd)data:base64Binary>?
< 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.; (xsd)url>?
< 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.; (xsd)size:integer64>?
< 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.; (xsd)hash:base64Binary>?
< A label or set of text to display in place of the data. May sometimes be derived from the source filename.; (xsd)title:string>?
< The date that the attachment was first created.; (xsd)creation:dateTime>?
< Height of the image in pixels (photo/video).; (xsd)height:positiveInt>?
< Width of the image in pixels (photo/video).; (xsd)width:positiveInt>?
< The number of frames in a photo. This is used with a multi-page fax, or an imaging acquisition context that takes multiple slices in a single image, or an animated gif. If there is more than one frame, this SHALL have a value in order to alert interface software that a multi-frame capable rendering widget is required. if the number of frames is not supplied, the value may be unknown. Applications should not assume that there is only one frame unless it is explicitly stated.; (xsd)frames:positiveInt>?
< The duration of the recording in seconds - for audio and video. The duration might differ from occurrencePeriod if recording was paused.; (xsd)duration:decimal>?
< The number of pages when printed.; (xsd)pages:positiveInt>?🔗 Related artifacts such as additional documentation, justification, or bibliographic references. Each related artifact is either an attachment, or a reference to another resource, but not both.fhirpathlibrary.dependency(xsd)(doc)=
<#base:logiclibrary.dependency>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< The type of relationship to the related artifact. The presence of both sides of a relationship type (e.g. successor and predecessor) is required to support use cases where one side of a relationship is not represented in FHIR. However, this feature SHALL NOT be used to create bi-directional resource links in FHIR instances. Specifically, following the methodology of "new points to old" and "many points to one", when using related artifact elements to describe and reference FHIR resources, the type element SHALL be drawn from the fhir-related-artifact-type ValueSet. Binding: related-artifact-type (required, The type of relationship to the related artifact.) depends-on; (xsd)type:code>
[]< Provides additional classifiers of the related artifact. Binding: citation-artifact-classifier (example, Additional classifiers for the related artifact.); (xsd)classifier:CodeableConcept>*
< A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index.; (xsd)label:string>?
< A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.; (xsd)display:string>?
< 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.; (xsd)citation:markdown>?
< The document being referenced, represented as an attachment. This is exclusive with the resource element.; (xsd)document:Attachment>?
< The related artifact, 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.; (xsd)resource:(<CodeSystem>
|<Library>
|<ValueSet>)>
< The related artifact, if the artifact is not a canonical resource, or a resource reference to a canonical resource. If both resource and resourceReference are present, they SHOULD be consistent and reference the same resource. Although relatedArtifact is intended to support references to definitional resources, there are cases where non-definitional resources can be definitional (such as Location where the kind is mode). Related artifacts SHOULD be used to reference definitional resources, and profiles SHOULD be used to make that explicit for particular use cases.; (xsd)resourceReference:Resource*>?
< The publication status of the artifact being referred to. Binding: publication-status (required, Publication status of an artifact being referred to.); (xsd)publicationStatus:code>?
< The date of publication of the artifact being referred to.; (xsd)publicationDate:date>?🔗 The FHIRPath content represented as base-64 encoded data.fhirpathlibrary.fhirPathContent(xsd)(doc)=
<#base:Attachment>
< The id of the FHIRPath expression. This id allows the expressions of the library to be referenced.; (xsd)id:string>
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< 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. Binding: mimetypes (required, BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)) text/fhirpath; (xsd)contentType:code>
< The human language of the content. The value can be any valid value according to BCP 47. Binding: all-languages (required, IETF language tag for a human language.); (xsd)language:code>?
< 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.; (xsd)data:base64Binary>
< 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.; (xsd)url>?
< 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.; (xsd)size:integer64>?
< 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.; (xsd)hash:base64Binary>?
< A label or set of text to display in place of the data. May sometimes be derived from the source filename.; (xsd)title:string>?
< The date that the attachment was first created.; (xsd)creation:dateTime>?
< Height of the image in pixels (photo/video).; (xsd)height:positiveInt>?
< Width of the image in pixels (photo/video).; (xsd)width:positiveInt>?
< The number of frames in a photo. This is used with a multi-page fax, or an imaging acquisition context that takes multiple slices in a single image, or an animated gif. If there is more than one frame, this SHALL have a value in order to alert interface software that a multi-frame capable rendering widget is required. if the number of frames is not supplied, the value may be unknown. Applications should not assume that there is only one frame unless it is explicitly stated.; (xsd)frames:positiveInt>?
< The duration of the recording in seconds - for audio and video. The duration might differ from occurrencePeriod if recording was paused.; (xsd)duration:decimal>?
< The number of pages when printed.; (xsd)pages:positiveInt>?🔗 Prospective warnings of potential issues when providing care to the patient.Flag(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< Business identifiers assigned to this flag by the performer or other systems which remain constant as the resource is updated and propagates from server to server. This is a business identifier, not a resource identifier (see [discussion](resource.html#identifiers)). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.; (xsd)identifier:Identifier>*
< Supports basic workflow. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. Binding: flag-status (required, Indicates whether this flag is active and needs to be displayed to a user, or whether it is no longer needed or was entered in error.); (xsd)status:code>
[]< Allows a flag to be divided into different categories like clinical, administrative etc. Intended to be used as a means of filtering which flags are displayed to particular user or in a given context. The value set will often need to be adjusted based on local business rules and usage context. Binding: flag-category (example, A general category for flags for filtering/display purposes.); (xsd)category:CodeableConcept>*
< The coded value or textual component of the flag to display to the user. If non-coded, use CodeableConcept.text. This element should always be included in the narrative. Binding: flag-code (example, Detail codes identifying specific flagged issues.); (xsd)code:CodeableConcept>
< The patient, related person, location, group, organization, or practitioner etc. this is about record this flag is associated with.; (xsd)subject:(<Group>
|<Location>
|<Medication>
|<Organization>
|<Patient>
|<PlanDefinition>
|<Practitioner>
|<PractitionerRole>
|<Procedure>
|<RelatedPerson>)>
< The period of time from the activation of the flag to inactivation of the flag. If the flag is active, the end of the period should be unspecified.; (xsd)period:Period>?
< This alert is only relevant during the encounter. If both Flag.encounter and Flag.period are valued, then Flag.period.start shall not be before Encounter.period.start and Flag.period.end shall not be after Encounter.period.end.; (xsd)encounter:Encounter*>?
< The person, organization or device that created the flag.; (xsd)author:(<Device>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>?🔗 This resource describes a product or service that is available through a program and includes the conditions and constraints of availability. All of the information in this resource is specific to the inclusion of the item in the formulary and is not inherent to the item itself.FormularyItem(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< Business identifier for this formulary item.; (xsd)identifier:Identifier>*
< A code (or set of codes) that specify the product or service that is identified by this formulary item. Binding: medication-codes (example, A coded concept that defines the product or service identified by this formulary item.); (xsd)code:CodeableConcept>?
< The validity about the information of the formulary item and not of the underlying product or service itself. This status is intended to identify if the formulary item in a local system is in active use within the formulary. For example, a formulary might include a medicinal product and the status relates to its inclusion. At some point in the future, if the status of the formulary item is changed to "inactive" that means that it is no longer valid in the formulary. But the product itself might still be in active use and might be included in other formularies. Binding: formularyitem-status (required, A coded concept defining if the medication is in active use.); (xsd)status:code>?🔗 A GenomicStudy is a set of analyses performed to analyze and generate genomic data.GenomicStudy(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< Identifiers for this genomic study.; (xsd)identifier:Identifier>*
< The status of the genomic study. Binding: genomicstudy-status (required, The status of the GenomicStudy.); (xsd)status:code>
[]< The type of the study, e.g., Familial variant segregation, Functional variation detection, or Gene expression profiling. Binding: genomicstudy-type (example, The type relevant to GenomicStudy.); (xsd)type:CodeableConcept>*
< The primary subject of the genomic study.; (xsd)subject:(<BiologicallyDerivedProduct>
|<Group>
|<NutritionProduct>
|<Patient>
|<Substance>)>
< The healthcare event with which this genomics study is associated.; (xsd)encounter:Encounter*>?
< When the genomic study was started.; (xsd)startDate:dateTime>?
[]< Event resources that the genomic study is based on.; (xsd)basedOn:(<ServiceRequest>
|<Task>)>*
< Healthcare professional who requested or referred the genomic study.; (xsd)referrer:(<Practitioner>
|<PractitionerRole>)>?
[]< Healthcare professionals who interpreted the genomic study.; (xsd)interpreter:(<Practitioner>
|<PractitionerRole>)>*
[]< Why the genomic study was performed.; (xsd)reason:(<Condition>
|<Observation>)>*
< The defined protocol that describes the study.; (xsd)instantiatesCanonical:PlanDefinition*>?
< The URL pointing to an externally maintained protocol that describes the study.; (xsd)instantiatesUri:uri>?
[]< Comments related to the genomic study.; (xsd)note:Annotation>*
< Description of the genomic study.; (xsd)description:markdown>?
[]< The details about a specific analysis that was performed in this GenomicStudy.; (xsd)analysis:GenomicStudy.analysis>*🔗 The details about a specific analysis that was performed in this GenomicStudy.GenomicStudy.analysis(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< Identifiers for the analysis event.; (xsd)identifier:Identifier>*
[]< Type of the methods used in the analysis, e.g., Fluorescence in situ hybridization (FISH), Karyotyping, or Microsatellite instability testing (MSI). Binding: genomicstudy-methodtype (example, The method type of the GenomicStudy analysis.); (xsd)methodType:CodeableConcept>*
[]< Type of the genomic changes studied in the analysis, e.g., DNA, RNA, or amino acid change. Binding: genomicstudy-changetype (example, The change type relevant to GenomicStudy analysis.); (xsd)changeType:CodeableConcept>*
< The reference genome build that is used in this analysis. Binding: http://loinc.org/vs/LL1040-6 (extensible, Human reference sequence NCBI build ID); (xsd)genomeBuild:CodeableConcept>?
< The defined protocol that describes the analysis.; (xsd)instantiatesCanonical:(<ActivityDefinition>
|<PlanDefinition>)>?
< The URL pointing to an externally maintained protocol that describes the analysis.; (xsd)instantiatesUri:uri>?
< Name of the analysis event (human friendly).; (xsd)title:string>?
[]< The focus of a genomic analysis when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, child, or sibling. For example, in trio testing, the GenomicStudy.subject would be the child (proband) and the GenomicStudy.analysis.focus of a specific analysis would be the parent. If the focus of the analysis is not known, the value of this field SHALL use the data absent extension.; (xsd)focus:Resource*>*
[]< The specimen used in the analysis event.; (xsd)specimen:Specimen*>*
< The date of the analysis event.; (xsd)date:dateTime>?
[]< Any notes capture with the analysis event.; (xsd)note:Annotation>*
< The protocol that was performed for the analysis event.; (xsd)protocolPerformed:(<Procedure>
|<Task>)>?
[]< The genomic regions to be studied in the analysis (BED file).; (xsd)regionsStudied:(<DocumentReference>
|<Observation>)>*
[]< Genomic regions actually called in the analysis event (BED file).; (xsd)regionsCalled:(<DocumentReference>
|<Observation>)>*
[]< Inputs for the analysis event.; (xsd)input:GenomicStudy.analysis.input>*
[]< Outputs for the analysis event.; (xsd)output:GenomicStudy.analysis.output>*
[]< Performer for the analysis event.; (xsd)performer:GenomicStudy.analysis.performer>*
[]< Devices used for the analysis (e.g., instruments, software), with settings and parameters.; (xsd)device:GenomicStudy.analysis.device>*🔗 Devices used for the analysis (e.g., instruments, software), with settings and parameters.GenomicStudy.analysis.device(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Device used for the analysis.; (xsd)device:Device*>?
< Specific function for the device used for the analysis.; (xsd)function:CodeableConcept>?🔗 Inputs for the analysis event.GenomicStudy.analysis.input(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< File containing input data.; (xsd)file:DocumentReference*>?
< Type of input data, e.g., BAM, CRAM, or FASTA. Binding: genomicstudy-dataformat (example, The data format of the data file.); (xsd)type:CodeableConcept>?
< The analysis event or other GenomicStudy that generated this input file.; (xsd)generatedBy:(<GenomicStudy>
|<Identifier>)>?🔗 Outputs for the analysis event.GenomicStudy.analysis.output(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< File containing output data.; (xsd)file:DocumentReference*>?
< Type of output data, e.g., VCF, MAF, or BAM. Binding: genomicstudy-dataformat (example, The data format of the data file.); (xsd)type:CodeableConcept>?🔗 Performer for the analysis event.GenomicStudy.analysis.performer(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The organization, healthcare professional, or others who participated in performing this analysis.; (xsd)actor:(<Device>
|<Organization>
|<Practitioner>
|<PractitionerRole>)>?
< Role of the actor for this analysis.; (xsd)role:CodeableConcept>?🔗 Describes the intended objective(s) for a patient, group or organization care, for example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, etc. Goal can be achieving a particular change or merely maintaining a current state or even slowing a decline.Goal(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< Business identifiers assigned to this goal by the performer or other systems which remain constant as the resource is updated and propagates from server to server. This is a business identifier, not a resource identifier (see [discussion](resource.html#identifiers)). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.; (xsd)identifier:Identifier>*
< The state of the goal throughout its lifecycle. This element is labeled as a modifier because the lifecycleStatus contains codes that mark the resource as not currently valid. Binding: goal-status (required, Codes that reflect the current state of a goal and whether the goal is still being targeted.); (xsd)lifecycleStatus:code>
< Describes the progression, or lack thereof, towards the goal against the target. Binding: goal-achievement (preferred, Indicates the progression, or lack thereof, towards the goal against the target.); (xsd)achievementStatus:CodeableConcept>?
[]< Indicates a category the goal falls within. Binding: goal-category (example, Codes for grouping and sorting goals.); (xsd)category:CodeableConcept>*
< After meeting the goal, ongoing activity is needed to sustain the goal objective. For example, getting a yellow fever vaccination for a planned trip is a goal that is designed to be completed (continuous = false). A goal to sustain HbA1c levels would not be a one-time goal (continuous = true).; (xsd)continuous:boolean>?
< Identifies the mutually agreed level of importance associated with reaching/sustaining the goal. Extensions are available to track priorities as established by each participant (i.e. Priority from the patient's perspective, different practitioners' perspectives, family member's perspectives)
The ordinal extension on Coding can be used to convey a numerically comparable ranking to priority. (Keep in mind that different coding systems may use a "low value=important". Binding: goal-priority (preferred, The level of importance associated with a goal.); (xsd)priority:CodeableConcept>?
< Human-readable and/or coded description of a specific desired objective of care, such as "control blood pressure" or "negotiate an obstacle course" or "dance with child at wedding". If no code is available, use CodeableConcept.text. Binding: clinical-findings (example, Codes providing the details of a particular goal. This will generally be system or implementation guide-specific. In many systems, only the text element will be used.); (xsd)description:CodeableConcept>
< Identifies the patient, group or organization for whom the goal is being established.; (xsd)subject:(<Group>
|<Organization>
|<Patient>)>
< The date or event after which the goal should begin being pursued. Binding: goal-start-event (example, Codes describing events that can trigger the initiation of a goal.); (xsd)start:(<CodeableConcept>
|<date>)>?
[]< Indicates what should be done by when. When multiple targets are present for a single goal instance, all targets must be met for the overall goal to be met.; (xsd)target:Goal.target>*
< Identifies when the current status. I.e. When initially created, when achieved, when cancelled, etc. To see the date for past statuses, query history.; (xsd)statusDate:date>?
< Captures the reason for the current status. This will typically be captured for statuses such as rejected, on-hold or cancelled, but could be present for others.; (xsd)statusReason:string>?
< Indicates whose goal this is - patient goal, practitioner goal, etc. This is the individual or team responsible for establishing the goal, not necessarily who recorded it. (For that, use the Provenance resource.).; (xsd)source:(<CareTeam>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>?
[]< The identified conditions and other health record elements that are intended to be addressed by the goal.; (xsd)addresses:(<Condition>
|<MedicationRequest>
|<MedicationStatement>
|<NutritionOrder>
|<Observation>
|<Procedure>
|<RiskAssessment>
|<ServiceRequest>)>*
[]< Any comments related to the goal. May be used for progress notes, concerns or other related information that doesn't actually describe the goal itself.; (xsd)note:Annotation>*
[]< Identifies the change (or lack of change) at the point when the status of the goal is assessed. Note that this should not duplicate the goal status; The goal outcome is independent of the outcome of the related activities. For example, if the Goal is to achieve a target body weight of 150 lb and a care plan activity is defined to diet, then the care plan’s activity outcome could be calories consumed whereas goal outcome is an observation for the actual body weight measured. Binding: clinical-findings (example, The result of the goal; e.g. "25% increase in shoulder mobility", "Anxiety reduced to moderate levels". "15 kg weight loss sustained over 6 months".); (xsd)outcome:Observation*>*🔗 Indicates what should be done by when. When multiple targets are present for a single goal instance, all targets must be met for the overall goal to be met.Goal.target(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The parameter whose value is being tracked, e.g. body weight, blood pressure, or hemoglobin A1c level. Binding: observation-codes (example, Codes to identify the value being tracked, e.g. body weight, blood pressure, or hemoglobin A1c level.); (xsd)measure:CodeableConcept>?
< The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any focus value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any focus value at or above the low value. A CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the Goal.target.measure defines a coded value. Binding: (example, Codes to identify the target value of the focus to be achieved to signify the fulfillment of the goal.); (xsd)detail:(<boolean>
|<CodeableConcept>
|<integer>
|<Quantity>
|<Range>
|<Ratio>
|<string>)>?
< Indicates either the date or the duration after start by which the goal should be met.; (xsd)due:(<date>
|<Duration>)>?🔗 A formal computable definition of a graph of resources - that is, a coherent set of resources that form a graph by following references. The Graph Definition resource defines a set and makes rules about the set.GraphDefinition(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< An absolute URI that is used to identify this graph definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this graph definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the graph definition is stored on different servers. Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.
The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions).
In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.; (xsd)url:uri>?
[]< A formal identifier that is used to identify this GraphDefinition when it is represented in other formats, or referenced in a specification, model, design or an instance.; (xsd)identifier:Identifier>*
< The identifier that is used to identify this version of the graph definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the graph definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. There may be different graph definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the graph definition with the format [url]|[version]. The version SHOULD NOT contain a '#' - see [Business Version](resource.html#bv-format).; (xsd)version:string>?
< Indicates the mechanism used to compare versions to determine which is more current. If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined. Binding: version-algorithm (extensible, ); (xsd)versionAlgorithm:(<Coding>
|<string>)>?
< A natural language name identifying the graph definition. This name should be usable as an identifier for the module by machine processing applications such as code generation. The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.; (xsd)name:string>
< A short, descriptive, user-friendly title for the capability statement. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.; (xsd)title:string>?
< The status of this graph definition. Enables tracking the life-cycle of the content. Allows filtering of graph definitions that are appropriate for use versus not.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization). Binding: publication-status (required, The lifecycle status of an artifact.); (xsd)status:code>
< A Boolean value to indicate that this graph definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. Allows filtering of graph definitions that are appropriate for use versus not.; (xsd)experimental:boolean>?
< The date (and optionally time) when the graph definition was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the graph definition changes. The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the graph definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)date:dateTime>?
< The name of the organization or individual responsible for the release and ongoing maintenance of the graph definition. Usually an organization but may be an individual. The publisher (or steward) of the graph definition is the organization or individual primarily responsible for the maintenance and upkeep of the graph definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the graph definition. This item SHOULD be populated unless the information is available from context.; (xsd)publisher:string>?
[]< Contact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)contact:ContactDetail>*
< A free text natural language description of the graph definition from a consumer's perspective. This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the graph definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the graph definition is presumed to be the predominant language in the place the graph definition was created).; (xsd)description:markdown>?
[]< The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate graph definition instances. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.; (xsd)useContext:UsageContext>*
[]< A legal or geographic region in which the graph definition is intended to be used. It may be possible for the graph definition to be used in jurisdictions other than those for which it was originally designed or intended.
DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.) Binding: jurisdiction (extensible, Countries and regions within which this artifact is targeted for use.); (xsd)jurisdiction:CodeableConcept>*
< Explanation of why this graph definition is needed and why it has been designed as it has. This element does not describe the usage of the graph definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this graph definition.; (xsd)purpose:markdown>?
< A copyright statement relating to the graph definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the graph definition. ...; (xsd)copyright:markdown>?
< A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved'). The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.; (xsd)copyrightLabel:string>?
< The Node at which instances of this graph start. If there is no nominated start, the graph can start at any of the nodes.; (xsd)start:id>?
[]< Potential target for the link.; (xsd)node:GraphDefinition.node>*
[]< Links this graph makes rules about.; (xsd)link:GraphDefinition.link>*🔗 Links this graph makes rules about.GraphDefinition.link(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Information about why this link is of interest in this graph definition.; (xsd)description:string>?
< Minimum occurrences for this link.; (xsd)min:integer>?
< Maximum occurrences for this link.; (xsd)max:string>?
< The source node for this link.; (xsd)sourceId:id>
< A FHIRPath expression that identifies one of FHIR References to other resources. The path expression cannot contain a resolve() function. If there is no path, the link is a reverse lookup, using target.params. If the path is "*" then this means all references in the resource.; (xsd)path:string>?
< Which slice (if profiled).; (xsd)sliceName:string>?
< The target node for this link.; (xsd)targetId:id>
< A set of parameters to look up. At least one of the parameters must have the value {ref} which identifies the focus resource.; (xsd)params:string>?
[]< Compartment Consistency Rules.; (xsd)compartment:GraphDefinition.link.compartment>*🔗 Compartment Consistency Rules.GraphDefinition.link.compartment(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Defines how the compartment rule is used - whether it it is used to test whether resources are subject to the rule, or whether it is a rule that must be followed. All conditional rules are evaluated; if they are true, then the rules are evaluated. Binding: graph-compartment-use (required, ); (xsd)use:code>
< identical | matching | different | no-rule | custom. Binding: graph-compartment-rule (required, ); (xsd)rule:code>
< Identifies the compartment. Binding: compartment-type (required, ); (xsd)code>
< Custom rule, as a FHIRPath expression.; (xsd)expression:string>?
< Documentation for FHIRPath expression.; (xsd)description:string>?🔗 Potential target for the link.GraphDefinition.node(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Internal ID of node - target for link references.; (xsd)nodeId:id>
< Information about why this node is of interest in this graph definition.; (xsd)description:string>?
< Type of resource this link refers to. Binding: version-independent-all-resource-types (required, A type of resource, or a Reference (from all versions)); (xsd)type:code>
< Profile for the target resource.; (xsd)profile:StructureDefinition*>?🔗 Represents a defined collection of entities that may be discussed or acted upon collectively but which are not expected to act collectively, and are not formally or legally recognized; i.e. a collection of entities that isn't an Organization. If both Group.characteristic and Group.member are present, then the members are the individuals who were found who met the characteristic. It's possible that there might be other candidate members who meet the characteristic and aren't (yet) in the list. All members SHALL have the listed characteristics.Group(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< Business identifiers assigned to this participant by one of the applications involved. These identifiers remain constant as the resource is updated and propagates from server to server. Note: This is a business identifier, not a resource identifier (see [discussion](resource.html#identifiers)). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types.; (xsd)identifier:Identifier>*
< Indicates whether the record for the group is available for use or is merely being retained for historical purposes.; (xsd)active:boolean>?
< Identifies the broad classification of the kind of resources the group includes. Group members SHALL be of the appropriate resource type (Patient for person or animal; or Practitioner, PractitionerRole, Device, CareTeam, HealthcareService, Location, Organization, RelatedPerson, or Specimen for the other types.), or a Group of the resources of the appropriate type. Binding: group-type (required, Types of resources that are part of group.); (xsd)type:code>
< Basis for membership in the Group:
* 'definitional': The Group.characteristics specified are both necessary and sufficient to determine membership. All entities that meet the criteria are considered to be members of the group, whether referenced by the group or not. If members are present, they are individuals that happen to be known as meeting the Group.characteristics. The list cannot be presumed to be complete.
* 'enumerated': The Group.characteristics are necessary but not sufficient to determine membership. Membership is determined by being listed as one of the Group.member. Binding: group-membership-basis (required, The basis for membership in a group); (xsd)membership:code>
< Provides a specific type of resource the group includes; e.g. "cow", "syringe", etc. This would generally be omitted for Person resources. Binding: (example, Kind of particular resource; e.g. cow, syringe, lake, etc.); (xsd)code:CodeableConcept>?
< A label assigned to the group for human identification and communication.; (xsd)name:string>?
< Explanation of what the group represents and how it is intended to be used.; (xsd)description:markdown>?
< A count of the number of resource instances that are part of the group. Note that the quantity may be less than the number of members if some of the members are not active.; (xsd)quantity:unsignedInt>?
< Entity responsible for defining and maintaining Group characteristics and/or registered members. This does not strictly align with ownership of a herd or flock, but may suffice to represent that relationship in simple cases. More complex cases will require an extension.; (xsd)managingEntity:(<Organization>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>?
[]< Identifies traits whose presence r absence is shared by members of the group. All the identified characteristics must be true for an entity to a member of the group.; (xsd)characteristic:Group.characteristic>*
[]< Identifies the resource instances that are members of the group.; (xsd)member:Group.member>*🔗 Identifies traits whose presence r absence is shared by members of the group. All the identified characteristics must be true for an entity to a member of the group.Group.characteristic(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A code that identifies the kind of trait being asserted. Binding: (example, List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.); (xsd)code:CodeableConcept>
(<valueBoolean:boolean>
|<valueCodeableConcept:CodeableConcept>
|<valueQuantity:Quantity>
|<valueRange:Range>
|<valueResource:Resource>)
< If true, indicates the characteristic is one that is NOT held by members of the group. This is labeled as "Is Modifier" because applications cannot wrongly include excluded members as included or vice versa.; (xsd)exclude:boolean>
< The period over which the characteristic is tested; e.g. the patient had an operation during the month of June.; (xsd)period:Period>?🔗 Identifies the resource instances that are members of the group.Group.member(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A reference to the entity that is a member of the group. Must be consistent with Group.type. If the entity is another group, then the type must be the same.; (xsd)entity:(<CareTeam>
|<Device>
|<Group>
|<HealthcareService>
|<Location>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>
|<Specimen>)>
< The period that the member was in the group, if known.; (xsd)period:Period>?
< A flag to indicate that the member is no longer in the group, but previously may have been a member.; (xsd)inactive:boolean>?🔗 Represents a defined collection of entities that may be discussed or acted upon collectively but which are not expected to act collectively, and are not formally or legally recognized; i.e. a collection of entities that isn't an Organization. If both Group.characteristic and Group.member are present, then the members are the individuals who were found who met the characteristic. It's possible that there might be other candidate members who meet the characteristic and aren't (yet) in the list. All members SHALL have the listed characteristics.groupdefinition(xsd)(doc)=
<#base:Group>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< Business identifiers assigned to this participant by one of the applications involved. These identifiers remain constant as the resource is updated and propagates from server to server. Note: This is a business identifier, not a resource identifier (see [discussion](resource.html#identifiers)). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types.; (xsd)identifier:Identifier>*
< Indicates whether the record for the group is available for use or is merely being retained for historical purposes.; (xsd)active:boolean>?
< Identifies the broad classification of the kind of resources the group includes. Group members SHALL be of the appropriate resource type (Patient for person or animal; or Practitioner, PractitionerRole, Device, CareTeam, HealthcareService, Location, Organization, RelatedPerson, or Specimen for the other types.), or a Group of the resources of the appropriate type. Binding: group-type (required, Types of resources that are part of group.); (xsd)type:code>
< Basis for membership in the Group:
* 'definitional': The Group.characteristics specified are both necessary and sufficient to determine membership. All entities that meet the criteria are considered to be members of the group, whether referenced by the group or not. If members are present, they are individuals that happen to be known as meeting the Group.characteristics. The list cannot be presumed to be complete.
* 'enumerated': The Group.characteristics are necessary but not sufficient to determine membership. Membership is determined by being listed as one of the Group.member. Binding: group-membership-basis (required, The basis for membership in a group) definitional; (xsd)membership:code>
< Provides a specific type of resource the group includes; e.g. "cow", "syringe", etc. This would generally be omitted for Person resources. Binding: (example, Kind of particular resource; e.g. cow, syringe, lake, etc.); (xsd)code:CodeableConcept>?
< A label assigned to the group for human identification and communication.; (xsd)name:string>?
< Explanation of what the group represents and how it is intended to be used.; (xsd)description:markdown>?
< A count of the number of resource instances that are part of the group. Note that the quantity may be less than the number of members if some of the members are not active.; (xsd)quantity:unsignedInt>?
< Entity responsible for defining and maintaining Group characteristics and/or registered members. This does not strictly align with ownership of a herd or flock, but may suffice to represent that relationship in simple cases. More complex cases will require an extension.; (xsd)managingEntity:(<Organization>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>?
[]< Identifies traits whose presence r absence is shared by members of the group. All the identified characteristics must be true for an entity to a member of the group.; (xsd)characteristic:groupdefinition.characteristic>+
[]< Identifies the resource instances that are members of the group.; (xsd)member:groupdefinition.member>*🔗 Identifies traits whose presence r absence is shared by members of the group. All the identified characteristics must be true for an entity to a member of the group.groupdefinition.characteristic(xsd)(doc)=
<#base:Group.characteristic>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A code that identifies the kind of trait being asserted. Binding: (example, List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.); (xsd)code:CodeableConcept>
(<valueBoolean:boolean>
|<valueCodeableConcept:CodeableConcept>
|<valueQuantity:Quantity>
|<valueRange:Range>
|<valueResource:Resource>)
< If true, indicates the characteristic is one that is NOT held by members of the group. This is labeled as "Is Modifier" because applications cannot wrongly include excluded members as included or vice versa.; (xsd)exclude:boolean>
< The period over which the characteristic is tested; e.g. the patient had an operation during the month of June.; (xsd)period:Period>?🔗 Identifies the resource instances that are members of the group.groupdefinition.member(xsd)(doc)=
<#base:Group.member>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A reference to the entity that is a member of the group. Must be consistent with Group.type. If the entity is another group, then the type must be the same.; (xsd)entity:(<CareTeam>
|<Device>
|<Group>
|<HealthcareService>
|<Location>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>
|<Specimen>)>
< The period that the member was in the group, if known.; (xsd)period:Period>?
< A flag to indicate that the member is no longer in the group, but previously may have been a member.; (xsd)inactive:boolean>?🔗 A guidance response is the formal response to a guidance request, including any output parameters returned by the evaluation, as well as the description of any proposed actions to be taken.GuidanceResponse(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< The identifier of the request associated with this response. If an identifier was given as part of the request, it will be reproduced here to enable the requester to more easily identify the response in a multi-request scenario.; (xsd)requestIdentifier:Identifier>?
[]< Allows a service to provide unique, business identifiers for the response.; (xsd)identifier:Identifier>*
< An identifier, CodeableConcept or canonical reference to the guidance that was requested. Binding: guidance-module-code (example, ); (xsd)module:(<CodeableConcept>
|<Resource>
|<uri>)>
< The status of the response. If the evaluation is completed successfully, the status will indicate success. However, in order to complete the evaluation, the engine may require more information. In this case, the status will be data-required, and the response will contain a description of the additional required information. If the evaluation completed successfully, but the engine determines that a potentially more accurate response could be provided if more data was available, the status will be data-requested, and the response will contain a description of the additional requested information. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. Binding: guidance-response-status (required, The status of a guidance response.); (xsd)status:code>
< The patient for which the request was processed.; (xsd)subject:(<Group>
|<Patient>)>?
< The encounter during which this response was created or to which the creation of this record is tightly associated. This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official copmletion of an encounter but still be tied to the context of the encounter.; (xsd)encounter:Encounter*>?
< Indicates when the guidance response was processed.; (xsd)occurrenceDateTime:dateTime>?
< Provides a reference to the device that performed the guidance.; (xsd)performer:Device*>?
[]< Describes the reason for the guidance response in coded or textual form, or Indicates the reason the request was initiated. This is typically provided as a parameter to the evaluation and echoed by the service, although for some use cases, such as subscription- or event-based scenarios, it may provide an indication of the cause for the response. Although this reference can be used to point to any resource, it is typically expected to refer to subject-specific data appropriate to the subject of the guidance. For example, patient-based decision support would be expected to reference patient-level data. In addition, implementations should provide as much detail as possible by using the [http://hl7.org/fhir/StructureDefinition/targetElement](http://hl7.org/fhir/extensions/StructureDefinition-targetElement.html) and [http://hl7.org/fhir/StructureDefinition/targetPath](http://hl7.org/fhir/extensions/StructureDefinition-targetPath.html) extensions to indicate the specific elements relevant to providing the reason for the guidance.; (xsd)reason:Resource*>*
[]< Provides a mechanism to communicate additional information about the response.; (xsd)note:Annotation>*
< Messages resulting from the evaluation of the artifact or artifacts. As part of evaluating the request, the engine may produce informational or warning messages. These messages will be provided by this element.; (xsd)evaluationMessage:OperationOutcome*>?
< The output parameters of the evaluation, if any. Many modules will result in the return of specific resources such as procedure or communication requests that are returned as part of the operation result. However, modules may define specific outputs that would be returned as the result of the evaluation, and these would be returned in this element.; (xsd)outputParameters:Parameters*>?
[]< The actions, if any, produced by the evaluation of the artifact.; (xsd)result:(<Appointment>
|<AppointmentResponse>
|<CarePlan>
|<Claim>
|<CommunicationRequest>
|<Contract>
|<CoverageEligibilityRequest>
|<DeviceRequest>
|<EnrollmentRequest>
|<ImmunizationRecommendation>
|<MedicationRequest>
|<NutritionOrder>
|<RequestOrchestration>
|<ServiceRequest>
|<SupplyRequest>
|<Task>
|<VisionPrescription>)>*
[]< If the evaluation could not be completed due to lack of information, or additional information would potentially result in a more accurate response, this element will a description of the data required in order to proceed with the evaluation. A subsequent request to the service should include this data.; (xsd)dataRequirement:DataRequirement>*🔗 Group of elements for HDL Cholesterol result. Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as laboratory reports, etc.hdlcholesterol(xsd)(doc)=
<#base:Observation>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< A unique identifier assigned to this observation.; (xsd)identifier:Identifier>*
< The reference to a FHIR ObservationDefinition resource that provides the definition that is adhered to in whole or in part by this Observation instance. ObservationDefinition can be referenced by its canonical url using instantiatesCanonical, or by a name or an identifier using the appropriate sub-elements of instantiatesReference.; (xsd)instantiates:ObservationDefinition*>?
[]< A plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed.; (xsd)basedOn:(<CarePlan>
|<DeviceRequest>
|<ImmunizationRecommendation>
|<MedicationRequest>
|<NutritionOrder>
|<ServiceRequest>)>*
[]< Identifies the observation(s) that triggered the performance of this observation.; (xsd)triggeredBy:hdlcholesterol.triggeredBy>*
[]< A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure. To link an Observation to an Encounter use `encounter`. See the [Notes](observation.html#obsgrouping) below for guidance on referencing another Observation.; (xsd)partOf:(<GenomicStudy>
|<ImagingStudy>
|<Immunization>
|<MedicationAdministration>
|<MedicationDispense>
|<MedicationStatement>
|<Procedure>)>*
< The status of the result value. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. Binding: observation-status (required, Codes providing the status of an observation.); (xsd)status:code>
[]< A code that classifies the general type of observation being made. In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set. Binding: observation-category (preferred, Codes for high level observation categories.); (xsd)category:CodeableConcept>*
< HDL Cholesterol. *All* code-value and, if present, component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. Binding: observation-codes (example, Codes identifying names of simple observations.) http://loinc.org, 2085-9, HDL Cholesterol; (xsd)code:CodeableConcept>
< The patient, or group of patients, location, device, organization, procedure or practitioner this observation is about and into whose or what record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the `focus` element or the `code` itself specifies the actual focus of the observation. One would expect this element to be a cardinality of 1..1. The only circumstance in which the subject can be missing is when the observation is made by a device that does not know the patient. In this case, the observation SHALL be matched to a patient through some context/channel matching technique, and at this point, the observation should be updated. The subject of an Observation may in some cases be a procedure. This supports the regulatory inspection use case where observations are captured during inspections of a procedure that is being performed (independent of any particular patient or whether patient related at all).; (xsd)subject:(<BiologicallyDerivedProduct>
|<Device>
|<Group>
|<Location>
|<Medication>
|<NutritionProduct>
|<Organization>
|<Patient>
|<Practitioner>
|<Procedure>
|<Substance>)>?
[]< The actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also be an existing condition, an intervention, the subject's diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child's tracheostomy tube. In this example, the child is the patient of record and the mother is the focus. Typically, an observation is made about the subject - a patient, or group of patients, location, or device - and the distinction between the subject and what is directly measured for an observation is specified in the observation code itself ( e.g., "Blood Glucose") and does not need to be represented separately using this element. Use `specimen` if a reference to a specimen is required. If a code is required instead of a resource use either `bodysite` for bodysites or the standard extension [http://hl7.org/fhir/StructureDefinition/observation-focusCode](http://hl7.org/fhir/extensions/StructureDefinition-observation-focusCode.html).; (xsd)focus:Resource*>*
< The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made. This will typically be the encounter the event occurred within, but some events may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission laboratory tests).; (xsd)encounter:Encounter*>?
< The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the "physiologically relevant time". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself. At least a date should be present unless this observation is a historical report. For recording imprecise or "fuzzy" times (For example, a blood glucose measurement taken "after breakfast") use the [Timing](datatypes.html#timing) datatype which allow the measurement to be tied to regular life events.; (xsd)effective:(<dateTime>
|<instant>
|<Period>
|<Timing>)>?
< The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified. For Observations that don't require review and verification, it may be the same as the [`lastUpdated` ](resource-definitions.html#Meta.lastUpdated) time of the resource itself. For Observations that do require review and verification for certain updates, it might not be the same as the `lastUpdated` time of the resource itself due to a non-clinically significant update that doesn't require the new version to be reviewed and verified again.; (xsd)issued:instant>?
[]< Who was responsible for asserting the observed value as "true".; (xsd)performer:(<CareTeam>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>*
(<valueAttachment:Attachment>
|<valueBoolean:boolean>
|<valueCodeableConcept:CodeableConcept>
|<valueDateTime:dateTime>
|<valueInteger:integer>
|<valueMolecularSequence:MolecularSequence>
|<valuePeriod:Period>
|<valueQuantity:Quantity>
|<valueRange:Range>
|<valueRatio:Ratio>
|<valueSampledData:SampledData>
|<valueString:string>
|<valueTime:time>)?
< Provides a reason why the expected value in the element Observation.value[x] is missing. Null or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be "detected", "not detected", "inconclusive", or "specimen unsatisfactory".
The alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code "error" could be used when the measurement was not completed. Note that an observation may only be reported if there are values to report. For example differential cell counts values may be reported only when > 0. Because of these options, use-case agreements are required to interpret general observations for null or exceptional values. Binding: data-absent-reason (extensible, Codes specifying why the result (`Observation.value[x]`) is missing.); (xsd)dataAbsentReason:CodeableConcept>?
< + | ++ | +++ | - | -- | ---. Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Binding: observation-interpretation (extensible, Codes identifying interpretations of observations.); (xsd)interpretation:CodeableConcept>?
[]< Comments about result. May include general statements about the observation, or statements about significant, unexpected or unreliable results values, or information about its source when relevant to its interpretation.; (xsd)note:Annotation>*
< Indicates the site on the subject's body where the observation was made (i.e. the target site). Only used if not implicit in code found in Observation.code. In many systems, this may be represented as a related observation instead of an inline component. Binding: body-site (example, SNOMED CT Body site concepts); (xsd)bodySite:CodeableConcept>?
< Indicates the body structure on the subject's body where the observation was made (i.e. the target site). Only used if not implicit in code found in Observation.code or bodySite is used. In many systems, this may be represented as a related observation instead of an inline component.; (xsd)bodyStructure:BodyStructure*>?
< Indicates the mechanism used to perform the observation. Only used if not implicit in code for Observation.code. Binding: observation-methods (example, Methods for simple observations.); (xsd)method:CodeableConcept>?
< The specimen that was used when this observation was made. Should only be used if not implicit in code found in `Observation.code`. Observations are not made on specimens themselves; they are made on a subject, but in many cases by the means of a specimen. Note that although specimens are often involved, they are not always tracked and reported explicitly. Also note that observation resources may be used in contexts that track the specimen explicitly (e.g. Diagnostic Report).; (xsd)specimen:(<Group>
|<Specimen>)>?
< A reference to the device that generates the measurements or the device settings for the device. Note that this is not meant to represent a device involved in the transmission of the result, e.g., a gateway. Such devices may be documented using the Provenance resource where relevant.; (xsd)device:(<Device>
|<DeviceMetric>)>?
< Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an "OR". In other words, to represent two distinct target populations, two `referenceRange` elements would be used. Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.; (xsd)referenceRange:hdlcholesterol.referenceRange>
< This observation is a group observation (e.g. a battery, a panel of tests, a set of vital sign measurements) that includes the target as a member of the group. When using this element, an observation will typically have either a value or a set of related resources, although both may be present in some cases. For a discussion on the ways Observations can assembled in groups together, see [Notes](observation.html#obsgrouping) below. Note that a system may calculate results from [QuestionnaireResponse](questionnaireresponse.html) into a final score and represent the score as an Observation.; (xsd)hasMember:(<MolecularSequence>
|<Observation>
|<QuestionnaireResponse>)>{0,0}
< The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image. All the reference choices that are listed in this element can represent clinical observations and other measurements that may be the source for a derived value. The most common reference will be another Observation. For a discussion on the ways Observations can assembled in groups together, see [Notes](observation.html#obsgrouping) below.; (xsd)derivedFrom:(<DocumentReference>
|<GenomicStudy>
|<ImagingSelection>
|<ImagingStudy>
|<MolecularSequence>
|<Observation>
|<QuestionnaireResponse>)>{0,0}
[]< Some observations have multiple component observations. These component observations are expressed as separate code value pairs that share the same attributes. Examples include systolic and diastolic component observations for blood pressure measurement and multiple component observations for genetics observations. For a discussion on the ways Observations can be assembled in groups together see [Notes](observation.html#notes) below.; (xsd)component:hdlcholesterol.component>*
< HDL Cholesterol value. If a result is not available, use the comments field. - An observation may have:
1. a single value here
1. both a value and a set of related or component values
1. only a set of related or component values.
- If a value is present, the datatype for this element should be determined by the `code`.
- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.
- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.
- The usage of valueReference is restricted to the MolecularSequence resource when used as a definitional resource, not as a patient-specific finding. .
- For additional guidance, see the [Notes section](observation.html#notes) below.; (xsd)valueQuantity:Quantity>?🔗 Some observations have multiple component observations. These component observations are expressed as separate code value pairs that share the same attributes. Examples include systolic and diastolic component observations for blood pressure measurement and multiple component observations for genetics observations. For a discussion on the ways Observations can be assembled in groups together see [Notes](observation.html#notes) below.hdlcholesterol.component(xsd)(doc)=
<#base:Observation.component>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Describes what was observed. Sometimes this is called the observation "code". *All* code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. Binding: observation-codes (example, Codes identifying names of simple observations.); (xsd)code:CodeableConcept>
(<valueAttachment:Attachment>
|<valueBoolean:boolean>
|<valueCodeableConcept:CodeableConcept>
|<valueDateTime:dateTime>
|<valueInteger:integer>
|<valueMolecularSequence:MolecularSequence>
|<valuePeriod:Period>
|<valueQuantity:Quantity>
|<valueRange:Range>
|<valueRatio:Ratio>
|<valueSampledData:SampledData>
|<valueString:string>
|<valueTime:time>)?
< Provides a reason why the expected value in the element Observation.component.value[x] is missing. "Null" or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be "detected", "not detected", "inconclusive", or "test not done".
The alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code "error" could be used when the measurement was not completed. Because of these options, use-case agreements are required to interpret general observations for exceptional values. Binding: data-absent-reason (extensible, Codes specifying why the result (`Observation.value[x]`) is missing.); (xsd)dataAbsentReason:CodeableConcept>?
[]< A categorical assessment of an observation value. For example, high, low, normal. Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Binding: observation-interpretation (extensible, Codes identifying interpretations of observations.); (xsd)interpretation:CodeableConcept>*
[]< Guidance on how to interpret the value by comparison to a normal or recommended range. Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.; (xsd)referenceRange:Observation.referenceRange>*🔗 Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an "OR". In other words, to represent two distinct target populations, two `referenceRange` elements would be used. Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.hdlcholesterol.referenceRange(xsd)(doc)=
<#base:Observation.referenceRange>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< >1.5 mmol/L. 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. 1,5; (xsd)low:SimpleQuantity>
< The value of the high bound of the reference range. The high bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the high bound is omitted, it is assumed to be meaningless (e.g. reference range is >= 2.3). Per Australian NHF Recommendations.; (xsd)high:SimpleQuantity>{0,0}
< The value of the normal value of the reference range. Binding: observation-referencerange-normalvalue (extensible, Codes identifying the normal value of the observation.); (xsd)normalValue:CodeableConcept>?
< Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range. This SHOULD be populated if there is more than one range. If this element is not present then the normal range is assumed. Binding: referencerange-meaning (preferred, Code for the meaning of a reference range.); (xsd)type:CodeableConcept>{0,0}
< Codes to indicate the target population this reference range applies to. For example, a reference range may be based on the normal population or a particular sex or race. Multiple `appliesTo` are interpreted as an "AND" of the target populations. For example, to represent a target population of African American females, both a code of female and a code for African American would be used. This SHOULD be populated if there is more than one range. If this element is not present then the normal population is assumed. Binding: referencerange-appliesto (example, Codes identifying the population the reference range applies to.); (xsd)appliesTo:CodeableConcept>{0,0}
< The age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so.; (xsd)age:Range>{0,0}
< Text based reference range in an observation which may be used when a quantitative range is not appropriate for an observation. An example would be a reference value of "Negative" or a list or table of "normals".; (xsd)text:markdown>?🔗 Identifies the observation(s) that triggered the performance of this observation.hdlcholesterol.triggeredBy(xsd)(doc)=
<#base:Observation.triggeredBy>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Reference to the triggering observation.; (xsd)observation:Observation*>
< The type of trigger.
Reflex | Repeat | Re-run. Binding: observation-triggeredbytype (required, The type of TriggeredBy Observation.); (xsd)type:code>
< Provides the reason why this observation was performed as a result of the observation(s) referenced.; (xsd)reason:string>?🔗 This profile defines how to represent Head Circumference observations in FHIR using a standard LOINC code and UCUM units of measure. Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as laboratory reports, etc.headcircum(xsd)(doc)=
<#base:vitalsigns>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< A unique identifier assigned to this observation.; (xsd)identifier:Identifier>*
< The reference to a FHIR ObservationDefinition resource that provides the definition that is adhered to in whole or in part by this Observation instance. ObservationDefinition can be referenced by its canonical url using instantiatesCanonical, or by a name or an identifier using the appropriate sub-elements of instantiatesReference.; (xsd)instantiates:ObservationDefinition*>?
[]< A plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed.; (xsd)basedOn:(<CarePlan>
|<DeviceRequest>
|<ImmunizationRecommendation>
|<MedicationRequest>
|<NutritionOrder>
|<ServiceRequest>)>*
[]< Identifies the observation(s) that triggered the performance of this observation.; (xsd)triggeredBy:headcircum.triggeredBy>*
[]< A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure. To link an Observation to an Encounter use `encounter`. See the [Notes](observation.html#obsgrouping) below for guidance on referencing another Observation.; (xsd)partOf:(<GenomicStudy>
|<ImagingStudy>
|<Immunization>
|<MedicationAdministration>
|<MedicationDispense>
|<MedicationStatement>
|<Procedure>)>*
< The status of the result value. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. Binding: observation-status (required, ); (xsd)status:code>
[]< A code that classifies the general type of observation being made. In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set. Binding: observation-category (preferred, Codes for high level observation categories.); (xsd)category:CodeableConcept>+
< Head Circumference. additional codes that translate or map to this code are allowed. For example a more granular LOINC code or code that is used locally in a system. Binding: observation-vitalsignresult (extensible, This identifies the vital sign result type. Original source C-CDA R1.1 , HITSP Vital Sign Result Type.); (xsd)code:headcircum.code>
< The patient, or group of patients, location, device, organization, procedure or practitioner this observation is about and into whose or what record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the `focus` element or the `code` itself specifies the actual focus of the observation. One would expect this element to be a cardinality of 1..1. The only circumstance in which the subject can be missing is when the observation is made by a device that does not know the patient. In this case, the observation SHALL be matched to a patient through some context/channel matching technique, and at this point, the observation should be updated. The subject of an Observation may in some cases be a procedure. This supports the regulatory inspection use case where observations are captured during inspections of a procedure that is being performed (independent of any particular patient or whether patient related at all).; (xsd)subject:Patient*>
[]< The actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also be an existing condition, an intervention, the subject's diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child's tracheostomy tube. In this example, the child is the patient of record and the mother is the focus. Typically, an observation is made about the subject - a patient, or group of patients, location, or device - and the distinction between the subject and what is directly measured for an observation is specified in the observation code itself ( e.g., "Blood Glucose") and does not need to be represented separately using this element. Use `specimen` if a reference to a specimen is required. If a code is required instead of a resource use either `bodysite` for bodysites or the standard extension [http://hl7.org/fhir/StructureDefinition/observation-focusCode](http://hl7.org/fhir/extensions/StructureDefinition-observation-focusCode.html).; (xsd)focus:Resource*>*
< The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made. This will typically be the encounter the event occurred within, but some events may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission laboratory tests).; (xsd)encounter:Encounter*>?
< Often just a dateTime for Vital Signs. At least a date should be present unless this observation is a historical report. For recording imprecise or "fuzzy" times (For example, a blood glucose measurement taken "after breakfast") use the [Timing](datatypes.html#timing) datatype which allow the measurement to be tied to regular life events.; (xsd)effective:(<dateTime>
|<Period>)>
< The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified. For Observations that don't require review and verification, it may be the same as the [`lastUpdated` ](resource-definitions.html#Meta.lastUpdated) time of the resource itself. For Observations that do require review and verification for certain updates, it might not be the same as the `lastUpdated` time of the resource itself due to a non-clinically significant update that doesn't require the new version to be reviewed and verified again.; (xsd)issued:instant>?
[]< Who was responsible for asserting the observed value as "true".; (xsd)performer:(<CareTeam>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>*
(<valueAttachment:Attachment>
|<valueBoolean:boolean>
|<valueCodeableConcept:CodeableConcept>
|<valueDateTime:dateTime>
|<valueInteger:integer>
|<valueMolecularSequence:MolecularSequence>
|<valuePeriod:Period>
|<valueQuantity:Quantity>
|<valueRange:Range>
|<valueRatio:Ratio>
|<valueSampledData:SampledData>
|<valueString:string>
|<valueTime:time>)?
< Provides a reason why the expected value in the element Observation.value[x] is missing. Null or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be "detected", "not detected", "inconclusive", or "specimen unsatisfactory".
The alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code "error" could be used when the measurement was not completed. Note that an observation may only be reported if there are values to report. For example differential cell counts values may be reported only when > 0. Because of these options, use-case agreements are required to interpret general observations for null or exceptional values. Binding: data-absent-reason (extensible, Codes specifying why the result (`Observation.value[x]`) is missing.); (xsd)dataAbsentReason:CodeableConcept>?
[]< A categorical assessment of an observation value. For example, high, low, normal. Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Binding: observation-interpretation (extensible, Codes identifying interpretations of observations.); (xsd)interpretation:CodeableConcept>*
[]< Comments about the observation or the results. May include general statements about the observation, or statements about significant, unexpected or unreliable results values, or information about its source when relevant to its interpretation.; (xsd)note:Annotation>*
< Indicates the site on the subject's body where the observation was made (i.e. the target site). Only used if not implicit in code found in Observation.code. In many systems, this may be represented as a related observation instead of an inline component. Binding: body-site (example, SNOMED CT Body site concepts); (xsd)bodySite:CodeableConcept>?
< Indicates the body structure on the subject's body where the observation was made (i.e. the target site). Only used if not implicit in code found in Observation.code or bodySite is used. In many systems, this may be represented as a related observation instead of an inline component.; (xsd)bodyStructure:BodyStructure*>?
< Indicates the mechanism used to perform the observation. Only used if not implicit in code for Observation.code. Binding: observation-methods (example, Methods for simple observations.); (xsd)method:CodeableConcept>?
< The specimen that was used when this observation was made. Should only be used if not implicit in code found in `Observation.code`. Observations are not made on specimens themselves; they are made on a subject, but in many cases by the means of a specimen. Note that although specimens are often involved, they are not always tracked and reported explicitly. Also note that observation resources may be used in contexts that track the specimen explicitly (e.g. Diagnostic Report).; (xsd)specimen:(<Group>
|<Specimen>)>?
< A reference to the device that generates the measurements or the device settings for the device. Note that this is not meant to represent a device involved in the transmission of the result, e.g., a gateway. Such devices may be documented using the Provenance resource where relevant.; (xsd)device:(<Device>
|<DeviceMetric>)>?
[]< Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an "OR". In other words, to represent two distinct target populations, two `referenceRange` elements would be used. Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.; (xsd)referenceRange:headcircum.referenceRange>*
[]< Used when reporting vital signs panel components. When using this element, an observation will typically have either a value or a set of related resources, although both may be present in some cases. For a discussion on the ways Observations can assembled in groups together, see [Notes](observation.html#obsgrouping) below. Note that a system may calculate results from [QuestionnaireResponse](questionnaireresponse.html) into a final score and represent the score as an Observation.; (xsd)hasMember:(<MolecularSequence>
|<QuestionnaireResponse>
|<vitalsigns>)>*
[]< The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image. All the reference choices that are listed in this element can represent clinical observations and other measurements that may be the source for a derived value. The most common reference will be another Observation. For a discussion on the ways Observations can assembled in groups together, see [Notes](observation.html#obsgrouping) below.; (xsd)derivedFrom:(<DocumentReference>
|<ImagingStudy>
|<MolecularSequence>
|<QuestionnaireResponse>
|<vitalsigns>)>*
[]< Used when reporting systolic and diastolic blood pressure. For a discussion on the ways Observations can be assembled in groups together see [Notes](observation.html#notes) below.; (xsd)component:headcircum.component>*
< A code that classifies the general type of observation being made. In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set. Binding: observation-category (preferred, Codes for high level observation categories.); (xsd)VSCat:headcircum.VSCat>
< Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept. - An observation may have:
1. a single value here
1. both a value and a set of related or component values
1. only a set of related or component values.
- If a value is present, the datatype for this element should be determined by the `code`.
- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.
- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.
- The usage of valueReference is restricted to the MolecularSequence resource when used as a definitional resource, not as a patient-specific finding. .
- For additional guidance, see the [Notes section](observation.html#notes) below.; (xsd)valueQuantity:headcircum.valueQuantity>?🔗 Head Circumference. additional codes that translate or map to this code are allowed. For example a more granular LOINC code or code that is used locally in a system. Binding: observation-vitalsignresult (extensible, This identifies the vital sign result type. Original source C-CDA R1.1 , HITSP Vital Sign Result Type.)headcircum.code(xsd)(doc)=
<#base:CodeableConcept>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< 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.; (xsd)coding:Coding>*
< 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.; (xsd)text:string>?
< 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.; (xsd)HeadCircumCode:headcircum.code.HeadCircumCode>🔗 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.headcircum.code.HeadCircumCode(xsd)(doc)=
<#base:Coding>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< 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 be an absolute reference to some definition that establishes the system clearly and unambiguously. http://loinc.org; (xsd)system:uri>
< 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.; (xsd)version:string>?
< 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). 9843-4; (xsd)code>
< A representation of the meaning of the code in the system, following the rules of the system.; (xsd)display:string>?
< 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.; (xsd)userSelected:boolean>?🔗 Used when reporting systolic and diastolic blood pressure. For a discussion on the ways Observations can be assembled in groups together see [Notes](observation.html#notes) below.headcircum.component(xsd)(doc)=
<#base:Observation.component>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Describes what was observed. Sometimes this is called the observation "code". *All* code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. Binding: observation-vitalsignresult (extensible, This identifies the vital sign result type. Original source C-CDA R1.1 , HITSP Vital Sign Result Type.); (xsd)code:CodeableConcept>
(<valueAttachment:Attachment>
|<valueBoolean:boolean>
|<valueCodeableConcept:CodeableConcept>
|<valueDateTime:dateTime>
|<valueInteger:integer>
|<valueMolecularSequence:MolecularSequence>
|<valuePeriod:Period>
|<valueQuantity:Quantity>
|<valueRange:Range>
|<valueRatio:Ratio>
|<valueSampledData:SampledData>
|<valueString:string>
|<valueTime:time>)?
< Provides a reason why the expected value in the element Observation.component.value[x] is missing. "Null" or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be "detected", "not detected", "inconclusive", or "test not done".
The alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code "error" could be used when the measurement was not completed. Because of these options, use-case agreements are required to interpret general observations for exceptional values. Binding: data-absent-reason (extensible, Codes specifying why the result (`Observation.value[x]`) is missing.); (xsd)dataAbsentReason:CodeableConcept>?
[]< A categorical assessment of an observation value. For example, high, low, normal. Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Binding: observation-interpretation (extensible, Codes identifying interpretations of observations.); (xsd)interpretation:CodeableConcept>*
[]< Guidance on how to interpret the value by comparison to a normal or recommended range. Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.; (xsd)referenceRange:Observation.referenceRange>*
< Vital Sign Value recorded with UCUM. Used when observation has a set of component observations:
- An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was derived).
- If a value is present, the datatype for this element should be determined by the `code`.
- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.
- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.
- If a value is present, the datatype for this element should be determined by the `code`.
- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.
- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.
- The usage of valueReference is restricted to the MolecularSequence resource when used as a definitional resource, not as a patient-specific finding. .
- For additional guidance, see the [Notes section](observation.html#notes) below. Binding: ucum-vitals-common (required, Commonly encountered UCUM units for recording Vital Signs.); (xsd)valueQuantity:Quantity>?🔗 Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an "OR". In other words, to represent two distinct target populations, two `referenceRange` elements would be used. Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.headcircum.referenceRange(xsd)(doc)=
<#base:Observation.referenceRange>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The value of the low bound of the reference range. The low bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the low bound is omitted, it is assumed to be meaningless (e.g. reference range is <=2.3).; (xsd)low:SimpleQuantity>?
< The value of the high bound of the reference range. The high bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the high bound is omitted, it is assumed to be meaningless (e.g. reference range is >= 2.3).; (xsd)high:SimpleQuantity>?
< The value of the normal value of the reference range. Binding: observation-referencerange-normalvalue (extensible, Codes identifying the normal value of the observation.); (xsd)normalValue:CodeableConcept>?
< Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range. This SHOULD be populated if there is more than one range. If this element is not present then the normal range is assumed. Binding: referencerange-meaning (preferred, Code for the meaning of a reference range.); (xsd)type:CodeableConcept>?
[]< Codes to indicate the target population this reference range applies to. For example, a reference range may be based on the normal population or a particular sex or race. Multiple `appliesTo` are interpreted as an "AND" of the target populations. For example, to represent a target population of African American females, both a code of female and a code for African American would be used. This SHOULD be populated if there is more than one range. If this element is not present then the normal population is assumed. Binding: referencerange-appliesto (example, Codes identifying the population the reference range applies to.); (xsd)appliesTo:CodeableConcept>*
< The age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so.; (xsd)age:Range>?
< Text based reference range in an observation which may be used when a quantitative range is not appropriate for an observation. An example would be a reference value of "Negative" or a list or table of "normals".; (xsd)text:markdown>?🔗 Identifies the observation(s) that triggered the performance of this observation.headcircum.triggeredBy(xsd)(doc)=
<#base:Observation.triggeredBy>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Reference to the triggering observation.; (xsd)observation:Observation*>
< The type of trigger.
Reflex | Repeat | Re-run. Binding: observation-triggeredbytype (required, The type of TriggeredBy Observation.); (xsd)type:code>
< Provides the reason why this observation was performed as a result of the observation(s) referenced.; (xsd)reason:string>?🔗 Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept. - An observation may have:
1. a single value here
1. both a value and a set of related or component values
1. only a set of related or component values.
- If a value is present, the datatype for this element should be determined by the `code`.
- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.
- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.
- The usage of valueReference is restricted to the MolecularSequence resource when used as a definitional resource, not as a patient-specific finding. .
- For additional guidance, see the [Notes section](observation.html#notes) below.headcircum.valueQuantity(xsd)(doc)=
<#base:Quantity>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< 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).; (xsd)value:decimal>
< 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. Binding: quantity-comparator (required, How the Quantity should be understood and represented.); (xsd)comparator:code>?
< A human-readable form of the unit.; (xsd)unit:string>
< The identification of the system that provides the coded form of the unit. http://unitsofmeasure.org; (xsd)system:uri>
< Coded responses from the common UCUM units for vital signs value set. 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. Binding: ucum-bodylength (required, cm | [in_i]); (xsd)code>🔗 A code that classifies the general type of observation being made. In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set. Binding: observation-category (preferred, Codes for high level observation categories.)headcircum.VSCat(xsd)(doc)=
<#base:vitalsigns.VSCat>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< 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.; (xsd)coding:headcircum.VSCat.coding>+
< 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.; (xsd)text:string>?🔗 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.headcircum.VSCat.coding(xsd)(doc)=
<#base:vitalsigns.VSCat.coding>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< 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 be an absolute reference to some definition that establishes the system clearly and unambiguously. http://terminology.hl7.org/CodeSystem/observation-category; (xsd)system:uri>
< 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.; (xsd)version:string>?
< 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). vital-signs; (xsd)code>
< A representation of the meaning of the code in the system, following the rules of the system.; (xsd)display:string>?
< 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.; (xsd)userSelected:boolean>?🔗 The details of a healthcare service available at a location.HealthcareService(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< External identifiers for this item.; (xsd)identifier:Identifier>*
< This flag is used to mark the record to not be used. This is not used when a center is closed for maintenance, or for holidays, the notAvailable period is to be used for this. This element is labeled as a modifier because it may be used to mark that the resource was created in error.; (xsd)active:boolean>?
< The organization that provides this healthcare service. This property is recommended to be the same as the Location's managingOrganization, and if not provided should be interpreted as such. If the Location does not have a managing Organization, then this property should be populated.; (xsd)providedBy:Organization*>?
[]< When the HealthcareService is representing a specific, schedulable service, the availableIn property can refer to a generic service. For example, if there is a generic Radiology service that offers CT Scans, MRIs, etc. You could have HealthcareService resources for the CT Scans and MRIs, which have an offeredIn reference to the Radiology HealthcareService.; (xsd)offeredIn:HealthcareService*>*
[]< Identifies the broad category of service being performed or delivered. Selecting a Service Category then determines the list of relevant service types that can be selected in the primary service type. Binding: service-category (example, A category of the service(s) that could be provided.); (xsd)category:CodeableConcept>*
[]< The specific type of service that may be delivered or performed. Binding: service-type (example, Additional details about where the content was created (e.g. clinical specialty).); (xsd)type:CodeableConcept>*
[]< Collection of specialties handled by the Healthcare service. This is more of a medical term. Binding: c80-practice-codes (preferred, A specialty that a healthcare service may provide.); (xsd)specialty:CodeableConcept>*
[]< The location(s) where this healthcare service may be provided.; (xsd)location:Location*>*
< Further description of the service as it would be presented to a consumer while searching.; (xsd)name:string>?
< Any additional description of the service and/or any specific issues not covered by the other attributes, which can be displayed as further detail under the serviceName. Would expect that a user would not see this information on a search results, and it would only be available when viewing the complete details of the service.; (xsd)comment:markdown>?
< Extra details about the service that can't be placed in the other fields.; (xsd)extraDetails:markdown>?
< If there is a photo/symbol associated with this HealthcareService, it may be included here to facilitate quick identification of the service in a list.; (xsd)photo:Attachment>?
[]< The contact details of communication devices available relevant to the specific HealthcareService. This can include addresses, phone numbers, fax numbers, mobile numbers, email addresses and web sites. The address/telecom use code 'home' are not to be used. Note that these contacts are not the contact details of people who provide the service (that would be through PractitionerRole), these are official contacts for the HealthcareService itself for specific purposes. E.g. Mailing Addresses, Billing Addresses, Contact numbers for Booking or Billing Enquiries, general web address, web address for online bookings etc.
If this is empty (or the type of interest is empty), refer to the location's contacts.; (xsd)contact:ExtendedContactDetail>*
[]< The location(s) that this service is available to (not where the service is provided). The locations referenced by the coverage area can include both specific locations, including areas, and also conceptual domains too (mode = kind), such as a physical area (tri-state area) and some other attribute (covered by Example Care Organization). These types of Locations are often not managed by any specific organization. This could also include generic locations such as "in-home".; (xsd)coverageArea:Location*>*
[]< The code(s) that detail the conditions under which the healthcare service is available/offered. The provision means being commissioned by, contractually obliged or financially sourced. Types of costings that may apply to this healthcare service, such if the service may be available for free, some discounts available, or fees apply. Binding: service-provision-conditions (example, The code(s) that detail the conditions under which the healthcare service is available/offered.); (xsd)serviceProvisionCode:CodeableConcept>*
[]< Does this service have specific eligibility requirements that need to be met in order to use the service?; (xsd)eligibility:HealthcareService.eligibility>*
[]< Programs that this service is applicable to. Programs are often defined externally to an Organization, commonly by governments; e.g. Home and Community Care Programs, Homeless Program, …. Binding: program (example, Government or local programs that this service applies to.); (xsd)program:CodeableConcept>*
[]< Collection of characteristics (attributes). These could be such things as is wheelchair accessible. Binding: service-mode (example, A custom attribute that could be provided at a service (e.g. Wheelchair accessibility).); (xsd)characteristic:CodeableConcept>*
[]< Some services are specifically made available in multiple languages, this property permits a directory to declare the languages this is offered in. Typically this is only provided where a service operates in communities with mixed languages used. When using this property it indicates that the service is available with this language, it is not derived from the practitioners, and not all are required to use this language, just that this language is available while scheduling. Binding: all-languages (required, IETF language tag for a human language); (xsd)communication:CodeableConcept>*
[]< Ways that the service accepts referrals, if this is not provided then it is implied that no referral is required. Binding: service-referral-method (example, The methods of referral can be used when referring to a specific HealthcareService resource.); (xsd)referralMethod:CodeableConcept>*
< Indicates whether or not a prospective consumer will require an appointment for a particular service at a site to be provided by the Organization. Indicates if an appointment is required for access to this service.; (xsd)appointmentRequired:boolean>?
[]< A collection of times that the healthcare service is available. More detailed availability information may be provided in associated Schedule/Slot resources.
Systems may choose to render availability differently than it is exchanged on the interface. For example, rather than "Mon, Tue, Wed, Thur, Fri from 9am-12am; Mon, Tue, Wed, Thur, Fri from 1pm-5pm" as would be implied by two availableTime repetitions, an application could render this information as "Mon-Fri 9-12am and 1-5pm".
The NotAvailableTime(s) included indicate the general days/periods where the service is not available (for things such as public holidays).; (xsd)availability:Availability>*
[]< Technical endpoints providing access to services operated for the specific healthcare services defined at this resource.; (xsd)endpoint:Endpoint*>*🔗 Does this service have specific eligibility requirements that need to be met in order to use the service?HealthcareService.eligibility(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Coded value for the eligibility. Binding: (example, Coded values underwhich a specific service is made available.); (xsd)code:CodeableConcept>?
< Describes the eligibility conditions for the service. The description of service eligibility should, in general, not exceed one or two paragraphs. It should be sufficient for a prospective consumer to determine if they are likely to be eligible or not. Where eligibility requirements and conditions are complex, it may simply be noted that an eligibility assessment is required. Where eligibility is determined by an outside source, such as an Act of Parliament, this should be noted, preferably with a reference to a commonly available copy of the source document such as a web page.; (xsd)comment:markdown>?🔗 This profile defines how to represent heart rate observations in FHIR using a standard LOINC code and UCUM units of measure. Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as laboratory reports, etc.heartrate(xsd)(doc)=
<#base:vitalsigns>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< A unique identifier assigned to this observation.; (xsd)identifier:Identifier>*
< The reference to a FHIR ObservationDefinition resource that provides the definition that is adhered to in whole or in part by this Observation instance. ObservationDefinition can be referenced by its canonical url using instantiatesCanonical, or by a name or an identifier using the appropriate sub-elements of instantiatesReference.; (xsd)instantiates:ObservationDefinition*>?
[]< A plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed.; (xsd)basedOn:(<CarePlan>
|<DeviceRequest>
|<ImmunizationRecommendation>
|<MedicationRequest>
|<NutritionOrder>
|<ServiceRequest>)>*
[]< Identifies the observation(s) that triggered the performance of this observation.; (xsd)triggeredBy:heartrate.triggeredBy>*
[]< A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure. To link an Observation to an Encounter use `encounter`. See the [Notes](observation.html#obsgrouping) below for guidance on referencing another Observation.; (xsd)partOf:(<GenomicStudy>
|<ImagingStudy>
|<Immunization>
|<MedicationAdministration>
|<MedicationDispense>
|<MedicationStatement>
|<Procedure>)>*
< The status of the result value. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. Binding: observation-status (required, ); (xsd)status:code>
[]< A code that classifies the general type of observation being made. In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set. Binding: observation-category (preferred, Codes for high level observation categories.); (xsd)category:CodeableConcept>+
< Heart Rate. additional codes that translate or map to this code are allowed. For example a more granular LOINC code or code that is used locally in a system. Binding: observation-vitalsignresult (extensible, This identifies the vital sign result type. Original source C-CDA R1.1 , HITSP Vital Sign Result Type.); (xsd)code:heartrate.code>
< The patient, or group of patients, location, device, organization, procedure or practitioner this observation is about and into whose or what record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the `focus` element or the `code` itself specifies the actual focus of the observation. One would expect this element to be a cardinality of 1..1. The only circumstance in which the subject can be missing is when the observation is made by a device that does not know the patient. In this case, the observation SHALL be matched to a patient through some context/channel matching technique, and at this point, the observation should be updated. The subject of an Observation may in some cases be a procedure. This supports the regulatory inspection use case where observations are captured during inspections of a procedure that is being performed (independent of any particular patient or whether patient related at all).; (xsd)subject:Patient*>
[]< The actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also be an existing condition, an intervention, the subject's diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child's tracheostomy tube. In this example, the child is the patient of record and the mother is the focus. Typically, an observation is made about the subject - a patient, or group of patients, location, or device - and the distinction between the subject and what is directly measured for an observation is specified in the observation code itself ( e.g., "Blood Glucose") and does not need to be represented separately using this element. Use `specimen` if a reference to a specimen is required. If a code is required instead of a resource use either `bodysite` for bodysites or the standard extension [http://hl7.org/fhir/StructureDefinition/observation-focusCode](http://hl7.org/fhir/extensions/StructureDefinition-observation-focusCode.html).; (xsd)focus:Resource*>*
< The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made. This will typically be the encounter the event occurred within, but some events may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission laboratory tests).; (xsd)encounter:Encounter*>?
< Often just a dateTime for Vital Signs. At least a date should be present unless this observation is a historical report. For recording imprecise or "fuzzy" times (For example, a blood glucose measurement taken "after breakfast") use the [Timing](datatypes.html#timing) datatype which allow the measurement to be tied to regular life events.; (xsd)effective:(<dateTime>
|<Period>)>
< The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified. For Observations that don't require review and verification, it may be the same as the [`lastUpdated` ](resource-definitions.html#Meta.lastUpdated) time of the resource itself. For Observations that do require review and verification for certain updates, it might not be the same as the `lastUpdated` time of the resource itself due to a non-clinically significant update that doesn't require the new version to be reviewed and verified again.; (xsd)issued:instant>?
[]< Who was responsible for asserting the observed value as "true".; (xsd)performer:(<CareTeam>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>*
(<valueAttachment:Attachment>
|<valueBoolean:boolean>
|<valueCodeableConcept:CodeableConcept>
|<valueDateTime:dateTime>
|<valueInteger:integer>
|<valueMolecularSequence:MolecularSequence>
|<valuePeriod:Period>
|<valueQuantity:Quantity>
|<valueRange:Range>
|<valueRatio:Ratio>
|<valueSampledData:SampledData>
|<valueString:string>
|<valueTime:time>)?
< Provides a reason why the expected value in the element Observation.value[x] is missing. Null or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be "detected", "not detected", "inconclusive", or "specimen unsatisfactory".
The alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code "error" could be used when the measurement was not completed. Note that an observation may only be reported if there are values to report. For example differential cell counts values may be reported only when > 0. Because of these options, use-case agreements are required to interpret general observations for null or exceptional values. Binding: data-absent-reason (extensible, Codes specifying why the result (`Observation.value[x]`) is missing.); (xsd)dataAbsentReason:CodeableConcept>?
[]< A categorical assessment of an observation value. For example, high, low, normal. Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Binding: observation-interpretation (extensible, Codes identifying interpretations of observations.); (xsd)interpretation:CodeableConcept>*
[]< Comments about the observation or the results. May include general statements about the observation, or statements about significant, unexpected or unreliable results values, or information about its source when relevant to its interpretation.; (xsd)note:Annotation>*
< Indicates the site on the subject's body where the observation was made (i.e. the target site). Only used if not implicit in code found in Observation.code. In many systems, this may be represented as a related observation instead of an inline component. Binding: body-site (example, SNOMED CT Body site concepts); (xsd)bodySite:CodeableConcept>?
< Indicates the body structure on the subject's body where the observation was made (i.e. the target site). Only used if not implicit in code found in Observation.code or bodySite is used. In many systems, this may be represented as a related observation instead of an inline component.; (xsd)bodyStructure:BodyStructure*>?
< Indicates the mechanism used to perform the observation. Only used if not implicit in code for Observation.code. Binding: observation-methods (example, Methods for simple observations.); (xsd)method:CodeableConcept>?
< The specimen that was used when this observation was made. Should only be used if not implicit in code found in `Observation.code`. Observations are not made on specimens themselves; they are made on a subject, but in many cases by the means of a specimen. Note that although specimens are often involved, they are not always tracked and reported explicitly. Also note that observation resources may be used in contexts that track the specimen explicitly (e.g. Diagnostic Report).; (xsd)specimen:(<Group>
|<Specimen>)>?
< A reference to the device that generates the measurements or the device settings for the device. Note that this is not meant to represent a device involved in the transmission of the result, e.g., a gateway. Such devices may be documented using the Provenance resource where relevant.; (xsd)device:(<Device>
|<DeviceMetric>)>?
[]< Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an "OR". In other words, to represent two distinct target populations, two `referenceRange` elements would be used. Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.; (xsd)referenceRange:heartrate.referenceRange>*
[]< Used when reporting vital signs panel components. When using this element, an observation will typically have either a value or a set of related resources, although both may be present in some cases. For a discussion on the ways Observations can assembled in groups together, see [Notes](observation.html#obsgrouping) below. Note that a system may calculate results from [QuestionnaireResponse](questionnaireresponse.html) into a final score and represent the score as an Observation.; (xsd)hasMember:(<MolecularSequence>
|<QuestionnaireResponse>
|<vitalsigns>)>*
[]< The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image. All the reference choices that are listed in this element can represent clinical observations and other measurements that may be the source for a derived value. The most common reference will be another Observation. For a discussion on the ways Observations can assembled in groups together, see [Notes](observation.html#obsgrouping) below.; (xsd)derivedFrom:(<DocumentReference>
|<ImagingStudy>
|<MolecularSequence>
|<QuestionnaireResponse>
|<vitalsigns>)>*
[]< Used when reporting systolic and diastolic blood pressure. For a discussion on the ways Observations can be assembled in groups together see [Notes](observation.html#notes) below.; (xsd)component:heartrate.component>*
< A code that classifies the general type of observation being made. In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set. Binding: observation-category (preferred, Codes for high level observation categories.); (xsd)VSCat:heartrate.VSCat>
< Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept. - An observation may have:
1. a single value here
1. both a value and a set of related or component values
1. only a set of related or component values.
- If a value is present, the datatype for this element should be determined by the `code`.
- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.
- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.
- The usage of valueReference is restricted to the MolecularSequence resource when used as a definitional resource, not as a patient-specific finding. .
- For additional guidance, see the [Notes section](observation.html#notes) below.; (xsd)valueQuantity:heartrate.valueQuantity>?🔗 Heart Rate. additional codes that translate or map to this code are allowed. For example a more granular LOINC code or code that is used locally in a system. Binding: observation-vitalsignresult (extensible, This identifies the vital sign result type. Original source C-CDA R1.1 , HITSP Vital Sign Result Type.)heartrate.code(xsd)(doc)=
<#base:CodeableConcept>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< 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.; (xsd)coding:Coding>*
< 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.; (xsd)text:string>?
< 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.; (xsd)HeartRateCode:heartrate.code.HeartRateCode>🔗 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.heartrate.code.HeartRateCode(xsd)(doc)=
<#base:Coding>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< 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 be an absolute reference to some definition that establishes the system clearly and unambiguously. http://loinc.org; (xsd)system:uri>
< 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.; (xsd)version:string>?
< 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). 8867-4; (xsd)code>
< A representation of the meaning of the code in the system, following the rules of the system.; (xsd)display:string>?
< 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.; (xsd)userSelected:boolean>?🔗 Used when reporting systolic and diastolic blood pressure. For a discussion on the ways Observations can be assembled in groups together see [Notes](observation.html#notes) below.heartrate.component(xsd)(doc)=
<#base:Observation.component>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Describes what was observed. Sometimes this is called the observation "code". *All* code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. Binding: observation-vitalsignresult (extensible, This identifies the vital sign result type. Original source C-CDA R1.1 , HITSP Vital Sign Result Type.); (xsd)code:CodeableConcept>
(<valueAttachment:Attachment>
|<valueBoolean:boolean>
|<valueCodeableConcept:CodeableConcept>
|<valueDateTime:dateTime>
|<valueInteger:integer>
|<valueMolecularSequence:MolecularSequence>
|<valuePeriod:Period>
|<valueQuantity:Quantity>
|<valueRange:Range>
|<valueRatio:Ratio>
|<valueSampledData:SampledData>
|<valueString:string>
|<valueTime:time>)?
< Provides a reason why the expected value in the element Observation.component.value[x] is missing. "Null" or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be "detected", "not detected", "inconclusive", or "test not done".
The alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code "error" could be used when the measurement was not completed. Because of these options, use-case agreements are required to interpret general observations for exceptional values. Binding: data-absent-reason (extensible, Codes specifying why the result (`Observation.value[x]`) is missing.); (xsd)dataAbsentReason:CodeableConcept>?
[]< A categorical assessment of an observation value. For example, high, low, normal. Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Binding: observation-interpretation (extensible, Codes identifying interpretations of observations.); (xsd)interpretation:CodeableConcept>*
[]< Guidance on how to interpret the value by comparison to a normal or recommended range. Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.; (xsd)referenceRange:Observation.referenceRange>*
< Vital Sign Value recorded with UCUM. Used when observation has a set of component observations:
- An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was derived).
- If a value is present, the datatype for this element should be determined by the `code`.
- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.
- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.
- If a value is present, the datatype for this element should be determined by the `code`.
- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.
- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.
- The usage of valueReference is restricted to the MolecularSequence resource when used as a definitional resource, not as a patient-specific finding. .
- For additional guidance, see the [Notes section](observation.html#notes) below. Binding: ucum-vitals-common (required, Commonly encountered UCUM units for recording Vital Signs.); (xsd)valueQuantity:Quantity>?🔗 Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an "OR". In other words, to represent two distinct target populations, two `referenceRange` elements would be used. Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.heartrate.referenceRange(xsd)(doc)=
<#base:Observation.referenceRange>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The value of the low bound of the reference range. The low bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the low bound is omitted, it is assumed to be meaningless (e.g. reference range is <=2.3).; (xsd)low:SimpleQuantity>?
< The value of the high bound of the reference range. The high bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the high bound is omitted, it is assumed to be meaningless (e.g. reference range is >= 2.3).; (xsd)high:SimpleQuantity>?
< The value of the normal value of the reference range. Binding: observation-referencerange-normalvalue (extensible, Codes identifying the normal value of the observation.); (xsd)normalValue:CodeableConcept>?
< Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range. This SHOULD be populated if there is more than one range. If this element is not present then the normal range is assumed. Binding: referencerange-meaning (preferred, Code for the meaning of a reference range.); (xsd)type:CodeableConcept>?
[]< Codes to indicate the target population this reference range applies to. For example, a reference range may be based on the normal population or a particular sex or race. Multiple `appliesTo` are interpreted as an "AND" of the target populations. For example, to represent a target population of African American females, both a code of female and a code for African American would be used. This SHOULD be populated if there is more than one range. If this element is not present then the normal population is assumed. Binding: referencerange-appliesto (example, Codes identifying the population the reference range applies to.); (xsd)appliesTo:CodeableConcept>*
< The age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so.; (xsd)age:Range>?
< Text based reference range in an observation which may be used when a quantitative range is not appropriate for an observation. An example would be a reference value of "Negative" or a list or table of "normals".; (xsd)text:markdown>?🔗 Identifies the observation(s) that triggered the performance of this observation.heartrate.triggeredBy(xsd)(doc)=
<#base:Observation.triggeredBy>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Reference to the triggering observation.; (xsd)observation:Observation*>
< The type of trigger.
Reflex | Repeat | Re-run. Binding: observation-triggeredbytype (required, The type of TriggeredBy Observation.); (xsd)type:code>
< Provides the reason why this observation was performed as a result of the observation(s) referenced.; (xsd)reason:string>?🔗 Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept. - An observation may have:
1. a single value here
1. both a value and a set of related or component values
1. only a set of related or component values.
- If a value is present, the datatype for this element should be determined by the `code`.
- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.
- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.
- The usage of valueReference is restricted to the MolecularSequence resource when used as a definitional resource, not as a patient-specific finding. .
- For additional guidance, see the [Notes section](observation.html#notes) below.heartrate.valueQuantity(xsd)(doc)=
<#base:Quantity>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< 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).; (xsd)value:decimal>
< 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. Binding: quantity-comparator (required, How the Quantity should be understood and represented.); (xsd)comparator:code>?
< A human-readable form of the unit.; (xsd)unit:string>
< The identification of the system that provides the coded form of the unit. http://unitsofmeasure.org; (xsd)system:uri>
< Coded responses from the common UCUM units for vital signs value set. 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. /min; (xsd)code>🔗 A code that classifies the general type of observation being made. In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set. Binding: observation-category (preferred, Codes for high level observation categories.)heartrate.VSCat(xsd)(doc)=
<#base:vitalsigns.VSCat>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< 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.; (xsd)coding:heartrate.VSCat.coding>+
< 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.; (xsd)text:string>?🔗 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.heartrate.VSCat.coding(xsd)(doc)=
<#base:vitalsigns.VSCat.coding>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< 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 be an absolute reference to some definition that establishes the system clearly and unambiguously. http://terminology.hl7.org/CodeSystem/observation-category; (xsd)system:uri>
< 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.; (xsd)version:string>?
< 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). vital-signs; (xsd)code>
< A representation of the meaning of the code in the system, following the rules of the system.; (xsd)display:string>?
< 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.; (xsd)userSelected:boolean>?🔗 A container for a collection of resources.history-bundle(xsd)(doc)=
<#base:Bundle>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< A persistent identifier for the bundle that won't change as a bundle is copied from server to server. Persistent identity generally only matters for batches of type Document, Message, and Collection. It would not normally be populated for search and history results and servers ignore Bundle.identifier when processing batches and transactions. For Documents the .identifier SHALL be populated such that the .identifier is globally unique.; (xsd)identifier:Identifier>?
< Indicates the purpose of this bundle - how it is intended to be used. It's possible to use a bundle for other purposes (e.g. a document can be accepted as a transaction). This is primarily defined so that there can be specific rules for some of the bundle types. Binding: bundle-type (required, Indicates the purpose of a bundle - how it is intended to be used.); (xsd)type:code>
< The date/time that the bundle was assembled - i.e. when the resources were placed in the bundle. For many bundles, the timestamp is equal to .meta.lastUpdated, because they are not stored (e.g. search results). When a bundle is placed in a persistent store, .meta.lastUpdated will be usually be changed by the server. When the bundle is a message, a middleware agent altering the message (even if not stored) SHOULD update .meta.lastUpdated. .timestamp is used to track the original time of the Bundle, and SHOULD be populated.
Usage:
* document : the date the document was created. Note: the composition may predate the document, or be associated with multiple documents. The date of the composition - the authoring time - may be earlier than the document assembly time
* message : the date that the content of the message was assembled. This date is not changed by middleware engines unless they add additional data that changes the meaning of the time of the message
* history : the date that the history was assembled. This time would be used as the _since time to ask for subsequent updates
* searchset : the time that the search set was assembled. Note that different pages MAY have different timestamps but need not. Having different timestamps does not imply that subsequent pages will represent or include changes made since the initial query
* transaction | transaction-response | batch | batch-response | collection : no particular assigned meaning
The timestamp value should be greater than the lastUpdated and other timestamps in the resources in the bundle, and it should be equal or earlier than the .meta.lastUpdated on the Bundle itself.; (xsd)timestamp:instant>?
< If a set of search matches, this is the (potentially estimated) total number of entries of type 'match' across all pages in the search. It does not include search.mode = 'include' or 'outcome' entries and it does not provide a count of the number of entries in the Bundle. Only used if the bundle is a search result set. The total does not include resources such as OperationOutcome and included resources, only the total number of matching resources.; (xsd)total:unsignedInt>?
[]< A series of links that provide context to this bundle. Both Bundle.link and Bundle.entry.link are defined to support providing additional context when Bundles are used (e.g. [HATEOAS](http://en.wikipedia.org/wiki/HATEOAS)).
Bundle.entry.link corresponds to links found in the HTTP header if the resource in the entry was [read](http.html#read) directly.
This specification defines some specific uses of Bundle.link for [searching](search.html#conformance) and [paging](http.html#paging), but no specific uses for Bundle.entry.link, and no defined function in a transaction - the meaning is implementation specific. The behavior of navigation link types (next/prev/first/last) are well defined for searchset and history Bundles but are not currently defined for other types. Implementers who choose to use such link relationships for other bundle types will need to negotiate behavior with their interoperability partners.; (xsd)link:history-bundle.link>*
[]< An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).; (xsd)entry:history-bundle.entry>*
< Digital Signature - base64 encoded. XML-DSig or a JWS. The signature could be created by the "author" of the bundle or by the originating device. Requirements around inclusion of a signature, verification of signatures and treatment of signed/non-signed bundles is implementation-environment specific.; (xsd)signature:Signature>?
< Captures issues and warnings that relate to the construction of the Bundle and the content within it. Usage notes: These issues and warnings must apply to the Bundle as a whole, not to individual entries.Messages relating to the processing of individual entries (e.g. in a batch or transaction) SHALL be reported in the entry.response.outcome for that entry. If there are errors that arise in the creation of the Bundle, then that should be handled by an OperationOutcome being returned instead of the Bundle.; (xsd)issues:OperationOutcome>?
[]< An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).; (xsd)put:history-bundle.put>*
< An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).; (xsd)post:history-bundle.post>{0,0}
[]< An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).; (xsd)get:history-bundle.get>*
[]< An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).; (xsd)delete:history-bundle.delete>*
< An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).; (xsd)patch:history-bundle.patch>{0,0}🔗 An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).history-bundle.delete(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< A series of links that provide context to this entry.; (xsd)link:Bundle.link>*
< The Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when:
* invoking a create
* invoking or responding to an operation where the body is not a single identified resource
* invoking or returning the results of a search or history operation. fullUrl might not be [unique in the context of a resource](bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](references.html), the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the [regex](references.html#regex), then the 'id' portion of the fullUrl SHALL end with the Resource.id.
Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).; (xsd)fullUrl:uri>
< The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. This is allowed to be a Parameters resource if and only if it is referenced by something else within the Bundle that provides context/meaning.; (xsd)resource:Resource>{0,0}
< Information about the search process that lead to the creation of this entry.; (xsd)search:history-bundle.delete.search>{0,0}
< Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.; (xsd)request:history-bundle.delete.request>
< Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.; (xsd)response:history-bundle.delete.response>🔗 Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.history-bundle.delete.request(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred. Binding: http-verb (required, HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details.); (xsd)method:code>
< The URL for this entry, relative to the root (the address to which the request is posted). E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]".; (xsd)url:uri>
< If the ETag values match, return a 304 Not Modified status. See the API documentation for ["Conditional Read"](http.html#cread).; (xsd)ifNoneMatch:string>?
< Only perform the operation if the last updated date matches. See the API documentation for ["Conditional Read"](http.html#cread).; (xsd)ifModifiedSince:instant>?
< Only perform the operation if the Etag value matches. For more information, see the API section ["Managing Resource Contention"](http.html#concurrency).; (xsd)ifMatch:string>?
< Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for ["Conditional Create"](http.html#ccreate). This is just the query portion of the URL - what follows the "?" (not including the "?").; (xsd)ifNoneExist:string>?🔗 Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.history-bundle.delete.response(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.; (xsd)status:string>
< The location header created by processing this operation, populated if the operation returns a location.; (xsd)location:uri>?
< The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)). Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.; (xsd)etag:string>?
< The date/time that the resource was modified on the server. This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.; (xsd)lastModified:instant>?
< An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction. For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.
This outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.; (xsd)outcome:Resource>?🔗 Information about the search process that lead to the creation of this entry.history-bundle.delete.search(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence. Binding: search-entry-mode (required, Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.); (xsd)mode:code>?
< When searching, the server's search ranking score for the entry. Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.
See [Patient Match](patient-operation-match.html) for the EMPI search which relates to this element.; (xsd)score:decimal>?🔗 An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).history-bundle.entry(xsd)(doc)=
<#base:Bundle.entry>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< A series of links that provide context to this entry.; (xsd)link:Bundle.link>*
< The Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when:
* invoking a create
* invoking or responding to an operation where the body is not a single identified resource
* invoking or returning the results of a search or history operation. fullUrl might not be [unique in the context of a resource](bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](references.html), the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the [regex](references.html#regex), then the 'id' portion of the fullUrl SHALL end with the Resource.id.
Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).; (xsd)fullUrl:uri>?
< The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. This is allowed to be a Parameters resource if and only if it is referenced by something else within the Bundle that provides context/meaning.; (xsd)resource:Resource>?
< Information about the search process that lead to the creation of this entry.; (xsd)search:history-bundle.entry.search>?
< Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.; (xsd)request:history-bundle.entry.request>?
< Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.; (xsd)response:history-bundle.entry.response>?🔗 Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.history-bundle.entry.request(xsd)(doc)=
<#base:Bundle.entry.request>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred. Binding: http-verb (required, HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details.); (xsd)method:code>
< The URL for this entry, relative to the root (the address to which the request is posted). E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]".; (xsd)url:uri>
< If the ETag values match, return a 304 Not Modified status. See the API documentation for ["Conditional Read"](http.html#cread).; (xsd)ifNoneMatch:string>?
< Only perform the operation if the last updated date matches. See the API documentation for ["Conditional Read"](http.html#cread).; (xsd)ifModifiedSince:instant>?
< Only perform the operation if the Etag value matches. For more information, see the API section ["Managing Resource Contention"](http.html#concurrency).; (xsd)ifMatch:string>?
< Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for ["Conditional Create"](http.html#ccreate). This is just the query portion of the URL - what follows the "?" (not including the "?").; (xsd)ifNoneExist:string>?🔗 Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.history-bundle.entry.response(xsd)(doc)=
<#base:Bundle.entry.response>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.; (xsd)status:string>
< The location header created by processing this operation, populated if the operation returns a location.; (xsd)location:uri>?
< The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)). Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.; (xsd)etag:string>?
< The date/time that the resource was modified on the server. This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.; (xsd)lastModified:instant>?
< An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction. For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.
This outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.; (xsd)outcome:Resource>?🔗 Information about the search process that lead to the creation of this entry.history-bundle.entry.search(xsd)(doc)=
<#base:Bundle.entry.search>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence. Binding: search-entry-mode (required, Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.); (xsd)mode:code>?
< When searching, the server's search ranking score for the entry. Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.
See [Patient Match](patient-operation-match.html) for the EMPI search which relates to this element.; (xsd)score:decimal>?🔗 An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).history-bundle.get(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< A series of links that provide context to this entry.; (xsd)link:Bundle.link>*
< The Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when:
* invoking a create
* invoking or responding to an operation where the body is not a single identified resource
* invoking or returning the results of a search or history operation. fullUrl might not be [unique in the context of a resource](bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](references.html), the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the [regex](references.html#regex), then the 'id' portion of the fullUrl SHALL end with the Resource.id.
Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).; (xsd)fullUrl:uri>
< The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. This is allowed to be a Parameters resource if and only if it is referenced by something else within the Bundle that provides context/meaning.; (xsd)resource:Resource>{0,0}
< Information about the search process that lead to the creation of this entry.; (xsd)search:history-bundle.get.search>{0,0}
< Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.; (xsd)request:history-bundle.get.request>
< Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.; (xsd)response:history-bundle.get.response>🔗 Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.history-bundle.get.request(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred. Binding: http-verb (required, HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details.); (xsd)method:code>
< The URL for this entry, relative to the root (the address to which the request is posted). E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]".; (xsd)url:uri>
< If the ETag values match, return a 304 Not Modified status. See the API documentation for ["Conditional Read"](http.html#cread).; (xsd)ifNoneMatch:string>?
< Only perform the operation if the last updated date matches. See the API documentation for ["Conditional Read"](http.html#cread).; (xsd)ifModifiedSince:instant>?
< Only perform the operation if the Etag value matches. For more information, see the API section ["Managing Resource Contention"](http.html#concurrency).; (xsd)ifMatch:string>?
< Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for ["Conditional Create"](http.html#ccreate). This is just the query portion of the URL - what follows the "?" (not including the "?").; (xsd)ifNoneExist:string>?🔗 Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.history-bundle.get.response(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.; (xsd)status:string>
< The location header created by processing this operation, populated if the operation returns a location.; (xsd)location:uri>?
< The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)). Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.; (xsd)etag:string>?
< The date/time that the resource was modified on the server. This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.; (xsd)lastModified:instant>?
< An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction. For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.
This outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.; (xsd)outcome:Resource>?🔗 Information about the search process that lead to the creation of this entry.history-bundle.get.search(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence. Binding: search-entry-mode (required, Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.); (xsd)mode:code>?
< When searching, the server's search ranking score for the entry. Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.
See [Patient Match](patient-operation-match.html) for the EMPI search which relates to this element.; (xsd)score:decimal>?🔗 A series of links that provide context to this bundle. Both Bundle.link and Bundle.entry.link are defined to support providing additional context when Bundles are used (e.g. [HATEOAS](http://en.wikipedia.org/wiki/HATEOAS)).
Bundle.entry.link corresponds to links found in the HTTP header if the resource in the entry was [read](http.html#read) directly.
This specification defines some specific uses of Bundle.link for [searching](search.html#conformance) and [paging](http.html#paging), but no specific uses for Bundle.entry.link, and no defined function in a transaction - the meaning is implementation specific. The behavior of navigation link types (next/prev/first/last) are well defined for searchset and history Bundles but are not currently defined for other types. Implementers who choose to use such link relationships for other bundle types will need to negotiate behavior with their interoperability partners.history-bundle.link(xsd)(doc)=
<#base:Bundle.link>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A name which details the functional use for this link - see [http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1](http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1). Binding: iana-link-relations (required, ); (xsd)relation:code>
< The reference details for the link.; (xsd)url:uri>🔗 An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).history-bundle.patch(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< A series of links that provide context to this entry.; (xsd)link:Bundle.link>*
< The Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when:
* invoking a create
* invoking or responding to an operation where the body is not a single identified resource
* invoking or returning the results of a search or history operation. fullUrl might not be [unique in the context of a resource](bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](references.html), the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the [regex](references.html#regex), then the 'id' portion of the fullUrl SHALL end with the Resource.id.
Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).; (xsd)fullUrl:uri>
< The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. This is allowed to be a Parameters resource if and only if it is referenced by something else within the Bundle that provides context/meaning.; (xsd)resource:Resource>?
< Information about the search process that lead to the creation of this entry.; (xsd)search:history-bundle.patch.search>?
< Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.; (xsd)request:history-bundle.patch.request>?
< Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.; (xsd)response:history-bundle.patch.response>?🔗 Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.history-bundle.patch.request(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred. Binding: http-verb (required, HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details.); (xsd)method:code>
< The URL for this entry, relative to the root (the address to which the request is posted). E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]".; (xsd)url:uri>
< If the ETag values match, return a 304 Not Modified status. See the API documentation for ["Conditional Read"](http.html#cread).; (xsd)ifNoneMatch:string>?
< Only perform the operation if the last updated date matches. See the API documentation for ["Conditional Read"](http.html#cread).; (xsd)ifModifiedSince:instant>?
< Only perform the operation if the Etag value matches. For more information, see the API section ["Managing Resource Contention"](http.html#concurrency).; (xsd)ifMatch:string>?
< Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for ["Conditional Create"](http.html#ccreate). This is just the query portion of the URL - what follows the "?" (not including the "?").; (xsd)ifNoneExist:string>?🔗 Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.history-bundle.patch.response(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.; (xsd)status:string>
< The location header created by processing this operation, populated if the operation returns a location.; (xsd)location:uri>?
< The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)). Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.; (xsd)etag:string>?
< The date/time that the resource was modified on the server. This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.; (xsd)lastModified:instant>?
< An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction. For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.
This outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.; (xsd)outcome:Resource>?🔗 Information about the search process that lead to the creation of this entry.history-bundle.patch.search(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence. Binding: search-entry-mode (required, Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.); (xsd)mode:code>?
< When searching, the server's search ranking score for the entry. Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.
See [Patient Match](patient-operation-match.html) for the EMPI search which relates to this element.; (xsd)score:decimal>?🔗 An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).history-bundle.post(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< A series of links that provide context to this entry.; (xsd)link:Bundle.link>*
< The Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when:
* invoking a create
* invoking or responding to an operation where the body is not a single identified resource
* invoking or returning the results of a search or history operation. fullUrl might not be [unique in the context of a resource](bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](references.html), the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the [regex](references.html#regex), then the 'id' portion of the fullUrl SHALL end with the Resource.id.
Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).; (xsd)fullUrl:uri>?
< The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. This is allowed to be a Parameters resource if and only if it is referenced by something else within the Bundle that provides context/meaning.; (xsd)resource:Resource>
< Information about the search process that lead to the creation of this entry.; (xsd)search:history-bundle.post.search>{0,0}
< Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.; (xsd)request:history-bundle.post.request>
< Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.; (xsd)response:history-bundle.post.response>🔗 Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.history-bundle.post.request(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred. Binding: http-verb (required, HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details.); (xsd)method:code>
< The URL for this entry, relative to the root (the address to which the request is posted). E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]".; (xsd)url:uri>
< If the ETag values match, return a 304 Not Modified status. See the API documentation for ["Conditional Read"](http.html#cread).; (xsd)ifNoneMatch:string>?
< Only perform the operation if the last updated date matches. See the API documentation for ["Conditional Read"](http.html#cread).; (xsd)ifModifiedSince:instant>?
< Only perform the operation if the Etag value matches. For more information, see the API section ["Managing Resource Contention"](http.html#concurrency).; (xsd)ifMatch:string>?
< Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for ["Conditional Create"](http.html#ccreate). This is just the query portion of the URL - what follows the "?" (not including the "?").; (xsd)ifNoneExist:string>?🔗 Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.history-bundle.post.response(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.; (xsd)status:string>
< The location header created by processing this operation, populated if the operation returns a location.; (xsd)location:uri>?
< The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)). Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.; (xsd)etag:string>?
< The date/time that the resource was modified on the server. This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.; (xsd)lastModified:instant>?
< An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction. For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.
This outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.; (xsd)outcome:Resource>?🔗 Information about the search process that lead to the creation of this entry.history-bundle.post.search(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence. Binding: search-entry-mode (required, Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.); (xsd)mode:code>?
< When searching, the server's search ranking score for the entry. Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.
See [Patient Match](patient-operation-match.html) for the EMPI search which relates to this element.; (xsd)score:decimal>?🔗 An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).history-bundle.put(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< A series of links that provide context to this entry.; (xsd)link:Bundle.link>*
< The Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when:
* invoking a create
* invoking or responding to an operation where the body is not a single identified resource
* invoking or returning the results of a search or history operation. fullUrl might not be [unique in the context of a resource](bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](references.html), the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the [regex](references.html#regex), then the 'id' portion of the fullUrl SHALL end with the Resource.id.
Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).; (xsd)fullUrl:uri>
< The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. This is allowed to be a Parameters resource if and only if it is referenced by something else within the Bundle that provides context/meaning.; (xsd)resource:Resource>
< Information about the search process that lead to the creation of this entry.; (xsd)search:history-bundle.put.search>{0,0}
< Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.; (xsd)request:history-bundle.put.request>
< Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.; (xsd)response:history-bundle.put.response>🔗 Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.history-bundle.put.request(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred. Binding: http-verb (required, HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details.); (xsd)method:code>
< The URL for this entry, relative to the root (the address to which the request is posted). E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]".; (xsd)url:uri>
< If the ETag values match, return a 304 Not Modified status. See the API documentation for ["Conditional Read"](http.html#cread).; (xsd)ifNoneMatch:string>?
< Only perform the operation if the last updated date matches. See the API documentation for ["Conditional Read"](http.html#cread).; (xsd)ifModifiedSince:instant>?
< Only perform the operation if the Etag value matches. For more information, see the API section ["Managing Resource Contention"](http.html#concurrency).; (xsd)ifMatch:string>?
< Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for ["Conditional Create"](http.html#ccreate). This is just the query portion of the URL - what follows the "?" (not including the "?").; (xsd)ifNoneExist:string>?🔗 Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.history-bundle.put.response(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.; (xsd)status:string>
< The location header created by processing this operation, populated if the operation returns a location.; (xsd)location:uri>?
< The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)). Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.; (xsd)etag:string>?
< The date/time that the resource was modified on the server. This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.; (xsd)lastModified:instant>?
< An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction. For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.
This outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.; (xsd)outcome:Resource>?🔗 Information about the search process that lead to the creation of this entry.history-bundle.put.search(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence. Binding: search-entry-mode (required, Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.); (xsd)mode:code>?
< When searching, the server's search ranking score for the entry. Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.
See [Patient Match](patient-operation-match.html) for the EMPI search which relates to this element.; (xsd)score:decimal>?🔗 A name, normally of a human, that can be used for other living entities (e.g. animals but not organizations) that have been assigned names by a human and may need the use of name parts or the need for usage information. 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(xsd)(doc)=
<#base:DataType>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< Identifies the purpose for this name. Applications can assume that a name is current unless it explicitly says that it is temporary or old. Binding: name-use (required, The use of a human name.); (xsd)use:code>?
< 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.; (xsd)text:string>?
< 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).; (xsd)family:string>?
[]< 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.; (xsd)given:string>*
[]< 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.; (xsd)prefix:string>*
[]< 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.; (xsd)suffix:string>*
< Indicates the period of time when this name was valid for the named person.; (xsd)period:Period>?🔗 The resource ChargeItem describes the provision of healthcare provider products for a certain patient, therefore referring not only to the product, but containing in addition details of the provision, like date, time, amounts and participating organizations and persons. Main Usage of the ChargeItem is to enable the billing process and internal cost allocation.ChargeItem(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< Identifiers assigned to this event performer or other systems.; (xsd)identifier:Identifier>*
[]< References the (external) source of pricing information, rules of application for the code this ChargeItem uses.; (xsd)definitionUri:uri>*
[]< References the source of pricing information, rules of application for the code this ChargeItem uses.; (xsd)definitionCanonical:ChargeItemDefinition*>*
< The current state of the ChargeItem. Unknown does not represent "other" - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is.
This element is labeled as a modifier because the status contains the code entered-in-error that marks the charge item as not currently valid. Binding: chargeitem-status (required, Codes identifying the lifecycle stage of a ChargeItem.); (xsd)status:code>
[]< ChargeItems can be grouped to larger ChargeItems covering the whole set.; (xsd)partOf:ChargeItem*>*
< A code that identifies the charge, like a billing code. Binding: chargeitem-billingcodes (example, Example codes for billing purposes); (xsd)code:CodeableConcept>
< The individual or set of individuals the action is being or was performed on.; (xsd)subject:(<Group>
|<Patient>)>
< This ChargeItem has the details of how the associated Encounter should be billed or otherwise be handled by finance systems. This ChargeItem may be recorded during planning, execution or after the actual encounter takes place.; (xsd)encounter:Encounter*>?
< Date/time(s) or duration when the charged service was applied. The list of types may be constrained as appropriate for the type of charge item.; (xsd)occurrence:(<dateTime>
|<Period>
|<Timing>)>?
[]< Indicates who or what performed or participated in the charged service.; (xsd)performer:ChargeItem.performer>*
< The organization performing the service. Practitioners and Devices can be associated with multiple organizations. It has to be made clear, on behalf of which Organization the services have been rendered.; (xsd)performingOrganization:Organization*>?
< The organization requesting the service. The rendered Service might not be associated with a Request. This property indicates which Organization requested the services to be rendered. (In many cases, this may just be the Department associated with the Encounter.location).; (xsd)requestingOrganization:Organization*>?
< The financial cost center permits the tracking of charge attribution. The costCenter could either be given as a reference to an Organization(Role) resource or as the identifier of the cost center determined by Reference.identifier.value and Reference.identifier.system, depending on use case requirements.; (xsd)costCenter:Organization*>?
< Quantity of which the charge item has been serviced. In many cases this may just be a value, if the underlying units are implicit in the definition of the charge item code.; (xsd)quantity:Quantity>?
[]< The anatomical location where the related service has been applied. Only used if not implicit in code found in Condition.code. If the use case requires attributes from the BodySite resource (e.g. to identify and track separately) then use the standard extension [http://hl7.org/fhir/StructureDefinition/bodySite](http://hl7.org/fhir/extensions/StructureDefinition-bodySite.html). May be a summary code, or a reference to a very precise definition of the location, or both. Binding: body-site (example, SNOMED CT Body site concepts); (xsd)bodysite:CodeableConcept>*
< The unit price of the chargable item. This could be communicated in ChargeItemDefinition. But if ChargeItemDefinition is not supported or not available, the unit price can be communicated in this property.; (xsd)unitPriceComponent:MonetaryComponent>?
< The total price for the chargable item, accounting for the quantity. Often, the total price may be be calculated and recorded on the Invoice, but if a calculated total price must be exchanged prior to Invoice creation, it can be communicated in this property.; (xsd)totalPriceComponent:MonetaryComponent>?
< If the list price or the rule-based factor associated with the code is overridden, this attribute can capture a text to indicate the reason for this action. Binding: (example, Local or regional codes covering why a price was overridden); (xsd)overrideReason:CodeableConcept>?
< The device, practitioner, etc. who entered the charge item. The enterer is also the person considered responsible for factor/price overrides if applicable.; (xsd)enterer:(<Device>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>?
< Date the charge item was entered. The actual date when the service associated with the charge has been rendered is captured in occurrence[x].; (xsd)enteredDate:dateTime>?
[]< Describes why the event occurred in coded or textual form. If the application of the charge item requires a reason to be given, it can be captured here. Textual reasons can be captured using reasonCode.text. Binding: icd-10 (example, ICD 10 diagnosis codes); (xsd)reason:CodeableConcept>*
[]< Indicated the rendered service that caused this charge.; (xsd)service:(<DiagnosticReport>
|<ImagingStudy>
|<Immunization>
|<MedicationAdministration>
|<MedicationDispense>
|<MedicationRequest>
|<Observation>
|<Procedure>
|<ServiceRequest>
|<SupplyDelivery>)>*
[]< Identifies the device, food, drug or other product being charged either by type code or reference to an instance. Binding: device-type (example, Example binding for product type.); (xsd)product:(<Device>
|<Medication>
|<Substance>)>*
[]< Account into which this ChargeItems belongs. Systems posting the ChargeItems might not always be able to determine, which accounts the Items need to be places into. It is up to the postprocessing Financial System to apply internal rules to decide based on the Encounter/EpisodeOfCare/Patient/Coverage context and the type of ChargeItem, which Account is appropriate.; (xsd)account:Account*>*
[]< Comments made about the event by the performer, subject or other participants.; (xsd)note:Annotation>*
[]< Further information supporting this charge.; (xsd)supportingInformation:Resource*>*🔗 Indicates who or what performed or participated in the charged service.ChargeItem.performer(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Describes the type of performance or participation(e.g. primary surgeon, anesthesiologiest, etc.). Binding: performer-role (example, Codes describing the types of functional roles performers can take on when performing events.); (xsd)function:CodeableConcept>?
< The device, practitioner, etc. who performed or participated in the service.; (xsd)actor:(<CareTeam>
|<Device>
|<HealthcareService>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>🔗 The ChargeItemDefinition resource provides the properties that apply to the (billing) codes necessary to calculate costs and prices. The properties may differ largely depending on type and realm, therefore this resource gives only a rough structure and requires profiling for each type of billing code system.ChargeItemDefinition(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< An absolute URI that is used to identify this charge item definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this charge item definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the charge item definition is stored on different servers. Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.
The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions).
In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.; (xsd)url:uri>?
[]< A formal identifier that is used to identify this charge item definition when it is represented in other formats, or referenced in a specification, model, design or an instance. Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this charge item definition outside of FHIR, where it is not possible to use the logical URI.; (xsd)identifier:Identifier>*
< The identifier that is used to identify this version of the charge item definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the charge item definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active assets. There may be different charge item definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the charge item definition with the format [url]|[version]. The version SHOULD NOT contain a '#' - see [Business Version](resource.html#bv-format).; (xsd)version:string>?
< Indicates the mechanism used to compare versions to determine which is more current. If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined. Binding: version-algorithm (extensible, ); (xsd)versionAlgorithm:(<Coding>
|<string>)>?
< A natural language name identifying the ChargeItemDefinition. This name should be usable as an identifier for the module by machine processing applications such as code generation. The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.; (xsd)name:string>?
< A short, descriptive, user-friendly title for the charge item definition. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.; (xsd)title:string>?
[]< The URL pointing to an externally-defined charge item definition that is adhered to in whole or in part by this definition.; (xsd)derivedFromUri:uri>*
[]< A larger definition of which this particular definition is a component or step.; (xsd)partOf:ChargeItemDefinition*>*
[]< As new versions of a protocol or guideline are defined, allows identification of what versions are replaced by a new instance.; (xsd)replaces:ChargeItemDefinition*>*
< The current state of the ChargeItemDefinition. Allows filtering of charge item definitions that are appropriate for use versus not.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization). Binding: publication-status (required, The lifecycle status of an artifact.); (xsd)status:code>
< A Boolean value to indicate that this charge item definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. Allows filtering of charge item definitions that are appropriate for use versus not.; (xsd)experimental:boolean>?
< The date (and optionally time) when the charge item definition was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the charge item definition changes. The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the charge item definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)date:dateTime>?
< The name of the organization or individual responsible for the release and ongoing maintenance of the charge item definition. Usually an organization but may be an individual. The publisher (or steward) of the charge item definition is the organization or individual primarily responsible for the maintenance and upkeep of the charge item definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the charge item definition. This item SHOULD be populated unless the information is available from context.; (xsd)publisher:string>?
[]< Contact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)contact:ContactDetail>*
< A free text natural language description of the charge item definition from a consumer's perspective. This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the charge item definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the charge item definition is presumed to be the predominant language in the place the charge item definition was created).; (xsd)description:markdown>?
[]< The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate charge item definition instances. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.; (xsd)useContext:UsageContext>*
[]< A legal or geographic region in which the charge item definition is intended to be used. It may be possible for the charge item definition to be used in jurisdictions other than those for which it was originally designed or intended.
DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.) Binding: jurisdiction (extensible, Countries and regions within which this artifact is targeted for use.); (xsd)jurisdiction:CodeableConcept>*
< Explanation of why this charge item definition is needed and why it has been designed as it has. This element does not describe the usage of the charge item definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this charge item definition.; (xsd)purpose:markdown>?
< A copyright statement relating to the charge item definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the charge item definition.; (xsd)copyright:markdown>?
< A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved'). The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.; (xsd)copyrightLabel:string>?
< The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)approvalDate:date>?
< The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. If specified, this date follows the original approval date.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)lastReviewDate:date>?
< The defined billing details in this resource pertain to the given billing code. Binding: chargeitem-billingcodes (example, Billing Code defined by this ChargeItemDefinition.); (xsd)code:CodeableConcept>?
[]< The defined billing details in this resource pertain to the given product instance(s). In case of highly customized, individually produced or fitted devices/substances, the pricing information may be different for each instance of the product. This reference links pricing details to specific product instances.; (xsd)instance:(<ActivityDefinition>
|<Device>
|<DeviceDefinition>
|<HealthcareService>
|<Medication>
|<PlanDefinition>
|<Substance>)>*
[]< Expressions that describe applicability criteria for the billing code. The applicability conditions can be used to ascertain whether a billing item is allowed in a specific context. E.g. some billing codes may only be applicable in out-patient settings, only to male/female patients or only to children.; (xsd)applicability:ChargeItemDefinition.applicability>*
[]< Group of properties which are applicable under the same conditions. If no applicability rules are established for the group, then all properties always apply.; (xsd)propertyGroup:ChargeItemDefinition.propertyGroup>*🔗 Expressions that describe applicability criteria for the billing code. The applicability conditions can be used to ascertain whether a billing item is allowed in a specific context. E.g. some billing codes may only be applicable in out-patient settings, only to male/female patients or only to children.ChargeItemDefinition.applicability(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< An expression that returns true or false, indicating whether the condition is satisfied. When using FHIRPath expressions, the %context environment variable must be replaced at runtime with the ChargeItem resource to which this definition is applied. Please note that FHIRPath Expressions can only be evaluated in the scope of the current ChargeItem resource to which this definition is being applied.
FHIRPath expressions can traverse into other resources linked from the ChargeItem resource, however, testing rules such as that a billing code may be billed only once per encounter need a wider scope. In such scenarios, CQL may be the appropriate choice.; (xsd)condition:Expression>?
< The period during which the charge item definition content was or is planned to be in active use. The effective period for a charge item definition determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 might be published in 2015.; (xsd)effectivePeriod:Period>?
< Reference to / quotation of the external source of the group of properties.; (xsd)relatedArtifact:RelatedArtifact>?🔗 Group of properties which are applicable under the same conditions. If no applicability rules are established for the group, then all properties always apply.ChargeItemDefinition.propertyGroup(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< Expressions that describe applicability criteria for the priceComponent. The applicability conditions can be used to ascertain whether a billing item is allowed in a specific context. E.g. some billing codes may only be applicable in out-patient settings, only to male/female patients or only to children.; (xsd)applicability:ChargeItemDefinition.applicability>*
[]< The price for a ChargeItem may be calculated as a base price with surcharges/deductions that apply in certain conditions. A ChargeItemDefinition resource that defines the prices, factors and conditions that apply to a billing code is currently under development. The priceComponent element can be used to offer transparency to the recipient of the Invoice of how the prices have been calculated.; (xsd)priceComponent:MonetaryComponent>*🔗 Measurements and simple assertions made about a patient, device or other subject. Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as laboratory reports, etc.cholesterol(xsd)(doc)=
<#base:Observation>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< A unique identifier assigned to this observation.; (xsd)identifier:Identifier>*
< The reference to a FHIR ObservationDefinition resource that provides the definition that is adhered to in whole or in part by this Observation instance. ObservationDefinition can be referenced by its canonical url using instantiatesCanonical, or by a name or an identifier using the appropriate sub-elements of instantiatesReference.; (xsd)instantiates:ObservationDefinition*>?
[]< A plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed.; (xsd)basedOn:(<CarePlan>
|<DeviceRequest>
|<ImmunizationRecommendation>
|<MedicationRequest>
|<NutritionOrder>
|<ServiceRequest>)>*
[]< Identifies the observation(s) that triggered the performance of this observation.; (xsd)triggeredBy:cholesterol.triggeredBy>*
[]< A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure. To link an Observation to an Encounter use `encounter`. See the [Notes](observation.html#obsgrouping) below for guidance on referencing another Observation.; (xsd)partOf:(<GenomicStudy>
|<ImagingStudy>
|<Immunization>
|<MedicationAdministration>
|<MedicationDispense>
|<MedicationStatement>
|<Procedure>)>*
< The status of the result value. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. Binding: observation-status (required, Codes providing the status of an observation.); (xsd)status:code>
[]< A code that classifies the general type of observation being made. In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set. Binding: observation-category (preferred, Codes for high level observation categories.); (xsd)category:CodeableConcept>*
< Cholesterol. *All* code-value and, if present, component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. Binding: observation-codes (example, Codes identifying names of simple observations.) http://loinc.org, 35200-5, Cholesterol [Moles/volume] in Serum or Plasma; (xsd)code:CodeableConcept>
< The patient, or group of patients, location, device, organization, procedure or practitioner this observation is about and into whose or what record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the `focus` element or the `code` itself specifies the actual focus of the observation. One would expect this element to be a cardinality of 1..1. The only circumstance in which the subject can be missing is when the observation is made by a device that does not know the patient. In this case, the observation SHALL be matched to a patient through some context/channel matching technique, and at this point, the observation should be updated. The subject of an Observation may in some cases be a procedure. This supports the regulatory inspection use case where observations are captured during inspections of a procedure that is being performed (independent of any particular patient or whether patient related at all).; (xsd)subject:(<BiologicallyDerivedProduct>
|<Device>
|<Group>
|<Location>
|<Medication>
|<NutritionProduct>
|<Organization>
|<Patient>
|<Practitioner>
|<Procedure>
|<Substance>)>?
[]< The actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also be an existing condition, an intervention, the subject's diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child's tracheostomy tube. In this example, the child is the patient of record and the mother is the focus. Typically, an observation is made about the subject - a patient, or group of patients, location, or device - and the distinction between the subject and what is directly measured for an observation is specified in the observation code itself ( e.g., "Blood Glucose") and does not need to be represented separately using this element. Use `specimen` if a reference to a specimen is required. If a code is required instead of a resource use either `bodysite` for bodysites or the standard extension [http://hl7.org/fhir/StructureDefinition/observation-focusCode](http://hl7.org/fhir/extensions/StructureDefinition-observation-focusCode.html).; (xsd)focus:Resource*>*
< The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made. This will typically be the encounter the event occurred within, but some events may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission laboratory tests).; (xsd)encounter:Encounter*>?
< The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the "physiologically relevant time". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself. At least a date should be present unless this observation is a historical report. For recording imprecise or "fuzzy" times (For example, a blood glucose measurement taken "after breakfast") use the [Timing](datatypes.html#timing) datatype which allow the measurement to be tied to regular life events.; (xsd)effective:(<dateTime>
|<instant>
|<Period>
|<Timing>)>?
< The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified. For Observations that don't require review and verification, it may be the same as the [`lastUpdated` ](resource-definitions.html#Meta.lastUpdated) time of the resource itself. For Observations that do require review and verification for certain updates, it might not be the same as the `lastUpdated` time of the resource itself due to a non-clinically significant update that doesn't require the new version to be reviewed and verified again.; (xsd)issued:instant>?
[]< Who was responsible for asserting the observed value as "true".; (xsd)performer:(<CareTeam>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>*
(<valueAttachment:Attachment>
|<valueBoolean:boolean>
|<valueCodeableConcept:CodeableConcept>
|<valueDateTime:dateTime>
|<valueInteger:integer>
|<valueMolecularSequence:MolecularSequence>
|<valuePeriod:Period>
|<valueQuantity:Quantity>
|<valueRange:Range>
|<valueRatio:Ratio>
|<valueSampledData:SampledData>
|<valueString:string>
|<valueTime:time>)?
< Provides a reason why the expected value in the element Observation.value[x] is missing. Null or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be "detected", "not detected", "inconclusive", or "specimen unsatisfactory".
The alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code "error" could be used when the measurement was not completed. Note that an observation may only be reported if there are values to report. For example differential cell counts values may be reported only when > 0. Because of these options, use-case agreements are required to interpret general observations for null or exceptional values. Binding: data-absent-reason (extensible, Codes specifying why the result (`Observation.value[x]`) is missing.); (xsd)dataAbsentReason:CodeableConcept>?
< + | ++ | +++ | - | -- | ---. Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Binding: observation-interpretation (extensible, Codes identifying interpretations of observations.); (xsd)interpretation:CodeableConcept>?
[]< May include statements about significant, unexpected or unreliable. values, or information about the source of the value where this may be relevant to the interpretation of the result. May include general statements about the observation, or statements about significant, unexpected or unreliable results values, or information about its source when relevant to its interpretation.; (xsd)note:Annotation>*
< Indicates the site on the subject's body where the observation was made (i.e. the target site). Only used if not implicit in code found in Observation.code. In many systems, this may be represented as a related observation instead of an inline component. Binding: body-site (example, SNOMED CT Body site concepts); (xsd)bodySite:CodeableConcept>?
< Indicates the body structure on the subject's body where the observation was made (i.e. the target site). Only used if not implicit in code found in Observation.code or bodySite is used. In many systems, this may be represented as a related observation instead of an inline component.; (xsd)bodyStructure:BodyStructure*>?
< Indicates the mechanism used to perform the observation. Only used if not implicit in code for Observation.code. Binding: observation-methods (example, Methods for simple observations.); (xsd)method:CodeableConcept>?
< The specimen that was used when this observation was made. Should only be used if not implicit in code found in `Observation.code`. Observations are not made on specimens themselves; they are made on a subject, but in many cases by the means of a specimen. Note that although specimens are often involved, they are not always tracked and reported explicitly. Also note that observation resources may be used in contexts that track the specimen explicitly (e.g. Diagnostic Report).; (xsd)specimen:(<Group>
|<Specimen>)>?
< A reference to the device that generates the measurements or the device settings for the device. Note that this is not meant to represent a device involved in the transmission of the result, e.g., a gateway. Such devices may be documented using the Provenance resource where relevant.; (xsd)device:(<Device>
|<DeviceMetric>)>?
< Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an "OR". In other words, to represent two distinct target populations, two `referenceRange` elements would be used. Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.; (xsd)referenceRange:cholesterol.referenceRange>
< This observation is a group observation (e.g. a battery, a panel of tests, a set of vital sign measurements) that includes the target as a member of the group. When using this element, an observation will typically have either a value or a set of related resources, although both may be present in some cases. For a discussion on the ways Observations can assembled in groups together, see [Notes](observation.html#obsgrouping) below. Note that a system may calculate results from [QuestionnaireResponse](questionnaireresponse.html) into a final score and represent the score as an Observation.; (xsd)hasMember:(<MolecularSequence>
|<Observation>
|<QuestionnaireResponse>)>{0,0}
< The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image. All the reference choices that are listed in this element can represent clinical observations and other measurements that may be the source for a derived value. The most common reference will be another Observation. For a discussion on the ways Observations can assembled in groups together, see [Notes](observation.html#obsgrouping) below.; (xsd)derivedFrom:(<DocumentReference>
|<GenomicStudy>
|<ImagingSelection>
|<ImagingStudy>
|<MolecularSequence>
|<Observation>
|<QuestionnaireResponse>)>{0,0}
[]< Some observations have multiple component observations. These component observations are expressed as separate code value pairs that share the same attributes. Examples include systolic and diastolic component observations for blood pressure measurement and multiple component observations for genetics observations. For a discussion on the ways Observations can be assembled in groups together see [Notes](observation.html#notes) below.; (xsd)component:cholesterol.component>*
< Cholesterol value. If a result is not available, use the comments field. - An observation may have:
1. a single value here
1. both a value and a set of related or component values
1. only a set of related or component values.
- If a value is present, the datatype for this element should be determined by the `code`.
- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.
- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.
- The usage of valueReference is restricted to the MolecularSequence resource when used as a definitional resource, not as a patient-specific finding. .
- For additional guidance, see the [Notes section](observation.html#notes) below.; (xsd)valueQuantity:cholesterol.valueQuantity>?🔗 Some observations have multiple component observations. These component observations are expressed as separate code value pairs that share the same attributes. Examples include systolic and diastolic component observations for blood pressure measurement and multiple component observations for genetics observations. For a discussion on the ways Observations can be assembled in groups together see [Notes](observation.html#notes) below.cholesterol.component(xsd)(doc)=
<#base:Observation.component>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Describes what was observed. Sometimes this is called the observation "code". *All* code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. Binding: observation-codes (example, Codes identifying names of simple observations.); (xsd)code:CodeableConcept>
(<valueAttachment:Attachment>
|<valueBoolean:boolean>
|<valueCodeableConcept:CodeableConcept>
|<valueDateTime:dateTime>
|<valueInteger:integer>
|<valueMolecularSequence:MolecularSequence>
|<valuePeriod:Period>
|<valueQuantity:Quantity>
|<valueRange:Range>
|<valueRatio:Ratio>
|<valueSampledData:SampledData>
|<valueString:string>
|<valueTime:time>)?
< Provides a reason why the expected value in the element Observation.component.value[x] is missing. "Null" or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be "detected", "not detected", "inconclusive", or "test not done".
The alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code "error" could be used when the measurement was not completed. Because of these options, use-case agreements are required to interpret general observations for exceptional values. Binding: data-absent-reason (extensible, Codes specifying why the result (`Observation.value[x]`) is missing.); (xsd)dataAbsentReason:CodeableConcept>?
[]< A categorical assessment of an observation value. For example, high, low, normal. Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Binding: observation-interpretation (extensible, Codes identifying interpretations of observations.); (xsd)interpretation:CodeableConcept>*
[]< Guidance on how to interpret the value by comparison to a normal or recommended range. Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.; (xsd)referenceRange:Observation.referenceRange>*🔗 Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an "OR". In other words, to represent two distinct target populations, two `referenceRange` elements would be used. Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.cholesterol.referenceRange(xsd)(doc)=
<#base:Observation.referenceRange>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The value of the low bound of the reference range. The low bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the low bound is omitted, it is assumed to be meaningless (e.g. reference range is <=2.3).; (xsd)low:SimpleQuantity>{0,0}
< <4.5 mmol/L. Per Australian NHF Recommendations. 4,5; (xsd)high:SimpleQuantity>
< The value of the normal value of the reference range. Binding: observation-referencerange-normalvalue (extensible, Codes identifying the normal value of the observation.); (xsd)normalValue:CodeableConcept>?
< Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range. This SHOULD be populated if there is more than one range. If this element is not present then the normal range is assumed. Binding: referencerange-meaning (preferred, Code for the meaning of a reference range.); (xsd)type:CodeableConcept>{0,0}
< Codes to indicate the target population this reference range applies to. For example, a reference range may be based on the normal population or a particular sex or race. Multiple `appliesTo` are interpreted as an "AND" of the target populations. For example, to represent a target population of African American females, both a code of female and a code for African American would be used. This SHOULD be populated if there is more than one range. If this element is not present then the normal population is assumed. Binding: referencerange-appliesto (example, Codes identifying the population the reference range applies to.); (xsd)appliesTo:CodeableConcept>{0,0}
< The age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so.; (xsd)age:Range>{0,0}
< Text based reference range in an observation which may be used when a quantitative range is not appropriate for an observation. An example would be a reference value of "Negative" or a list or table of "normals".; (xsd)text:markdown>?🔗 Identifies the observation(s) that triggered the performance of this observation.cholesterol.triggeredBy(xsd)(doc)=
<#base:Observation.triggeredBy>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Reference to the triggering observation.; (xsd)observation:Observation*>
< The type of trigger.
Reflex | Repeat | Re-run. Binding: observation-triggeredbytype (required, The type of TriggeredBy Observation.); (xsd)type:code>
< Provides the reason why this observation was performed as a result of the observation(s) referenced.; (xsd)reason:string>?🔗 Cholesterol value. If a result is not available, use the comments field. - An observation may have:
1. a single value here
1. both a value and a set of related or component values
1. only a set of related or component values.
- If a value is present, the datatype for this element should be determined by the `code`.
- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.
- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.
- The usage of valueReference is restricted to the MolecularSequence resource when used as a definitional resource, not as a patient-specific finding. .
- For additional guidance, see the [Notes section](observation.html#notes) below.cholesterol.valueQuantity(xsd)(doc)=
<#base:Quantity>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< Actual numerical 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).; (xsd)value:decimal>?
< 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. No need for this on cholesterol. Binding: quantity-comparator (required, How the Quantity should be understood and represented.); (xsd)comparator:code>{0,0}
< A human-readable form of the unit. mmol/L; (xsd)unit:string>
< The identification of the system that provides the coded form of the unit. http://unitsofmeasure.org; (xsd)system:uri>
< 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. mmol/L; (xsd)code>🔗 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 4122id(xsd)(doc)=
<#base:string>
< unique id for the element within a resource (for internal references); (xsd)id:string>?
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< Primitive value for id; (xsd)value:string>?🔗 An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. The rules of the identifier.type determine if a check digit is part of the ID value or sent separately, such as through the checkDigit extension.Identifier(xsd)(doc)=
<#base:DataType>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< The purpose of this identifier. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Binding: identifier-use (required, Identifies the purpose for this identifier, if known .); (xsd)use:code>?
< 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. Binding: identifier-type (extensible, A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.); (xsd)type:CodeableConcept>?
< Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique. Identifier.system is always case sensitive.; (xsd)system:uri>?
< The portion of the identifier typically relevant to the user and which is unique within the context of the system. If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [http://hl7.org/fhir/StructureDefinition/rendered-value](http://hl7.org/fhir/extensions/StructureDefinition-rendered-value.html)). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.; (xsd)value:string>?
< Time period during which identifier is/was valid for use.; (xsd)period:Period>?
< 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.; (xsd)assigner:Organization*>?🔗 A selection of DICOM SOP instances and/or frames within a single Study and Series. This might include additional specifics such as an image region, an Observation UID or a Segmentation Number, allowing linkage to an Observation Resource or transferring this information along with the ImagingStudy Resource.ImagingSelection(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< A unique identifier assigned to this imaging selection. This is a business identifier, not a resource identifier -- see discussion under [Business Identifiers](resource.html#identifiers). ; (xsd)identifier:Identifier>*
< The current state of the ImagingSelection resource. This is not the status of any ImagingStudy, ServiceRequest, or Task resources associated with the ImagingSelection. Unknown does not represent "other" - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is. Binding: imagingselection-status (required, The status of the ImagingSelection.); (xsd)status:code>
< The patient, or group of patients, location, device, organization, procedure or practitioner this imaging selection is about and into whose or what record the imaging selection is placed.; (xsd)subject:(<Device>
|<Group>
|<Location>
|<Medication>
|<Organization>
|<Patient>
|<Practitioner>
|<Procedure>
|<Specimen>
|<Substance>)>?
< The date and time this imaging selection was created.; (xsd)issued:instant>?
[]< Selector of the instances – human or machine.; (xsd)performer:ImagingSelection.performer>*
[]< A list of the diagnostic requests that resulted in this imaging selection being performed.; (xsd)basedOn:(<Appointment>
|<AppointmentResponse>
|<CarePlan>
|<ServiceRequest>
|<Task>)>*
[]< Classifies the imaging selection. Binding: http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_7010.html (example, Key Object Selection Document Title.); (xsd)category:CodeableConcept>*
< Reason for referencing the selected content. *All* code-value and, if present, component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. Binding: http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_7010.html (example, Key Object Selection Document Title.); (xsd)code:CodeableConcept>
< The Study Instance UID for the DICOM Study from which the images were selected. See [DICOM PS3.3 C.7.2](http://dicom.nema.org/medical/dicom/current/output/chtml/part03/sect_C.7.2.html).; (xsd)studyUid:id>?
[]< The imaging study from which the imaging selection is made.; (xsd)derivedFrom:(<DocumentReference>
|<ImagingStudy>)>*
[]< The network service providing retrieval access to the selected images, frames, etc. See implementation notes for information about using DICOM endpoints. Typical endpoint types include DICOM WADO-RS, which is used to retrieve DICOM instances in native or rendered (e.g., JPG, PNG) formats using a RESTful API; DICOM WADO-URI, which can similarly retrieve native or rendered instances, except using an HTTP query-based approach.; (xsd)endpoint:Endpoint*>*
< The Series Instance UID for the DICOM Series from which the images were selected. See [DICOM PS3.3 C.7.3](http://dicom.nema.org/medical/dicom/current/output/chtml/part03/sect_C.7.3.html).; (xsd)seriesUid:id>?
< The Series Number for the DICOM Series from which the images were selected. See [DICOM PS3.3 C.7.3](http://dicom.nema.org/medical/dicom/current/output/chtml/part03/sect_C.7.3.html).; (xsd)seriesNumber:unsignedInt>?
< The Frame of Reference UID identifying the coordinate system that conveys spatial and/or temporal information for the selected images or frames. See [DICOM PS3.3 C.7.4.1](http://dicom.nema.org/medical/dicom/current/output/chtml/part03/sect_C.7.4.html).; (xsd)frameOfReferenceUid:id>?
< The anatomic structures examined. See DICOM Part 16 Annex L (http://dicom.nema.org/medical/dicom/current/output/chtml/part16/chapter_L.html) for DICOM to SNOMED-CT mappings. Binding: body-site (example, SNOMED CT Body site concepts); (xsd)bodySite:BodyStructure*>?
[]< The actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also be an existing condition, an intervention, the subject's diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child's tracheostomy tube. In this example, the child is the patient of record and the mother is the focus. An imaging selection may reference a DICOM resource that itself references other DICOM resources.
e.g. a presentation state references a set of source images or frames.; (xsd)focus:ImagingSelection*>*
[]< Each imaging selection includes one or more selected DICOM SOP instances.; (xsd)instance:ImagingSelection.instance>*🔗 Each imaging selection includes one or more selected DICOM SOP instances.ImagingSelection.instance(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The SOP Instance UID for the selected DICOM instance. See [DICOM PS3.3 C.12.1](http://dicom.nema.org/medical/dicom/current/output/chtml/part03/sect_C.12.html).; (xsd)uid:id>
< The Instance Number for the selected DICOM instance. See [DICOM PS3.3 C.7.6.1](https://dicom.nema.org/medical/dicom/current/output/chtml/part03/sect_C.7.6.html#sect_C.7.6.1).
Note: A multiframe instance has a single instance number with each frame identified by a frame number.; (xsd)number:unsignedInt>?
< The SOP Class UID for the selected DICOM instance. See [DICOM PS3.3 C.12.1](http://dicom.nema.org/medical/dicom/current/output/chtml/part03/sect_C.12.html). Binding: http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1 (extensible, DICOM SOP Classes.); (xsd)sopClass:Coding>?
[]< Selected subset of the SOP Instance. The content and format of the subset item is determined by the SOP Class of the selected instance.
May be one of:
- A list of frame numbers selected from a multiframe SOP Instance.
- A list of Content Item Observation UID values selected from a DICOM SR or other structured document SOP Instance.
- A list of segment numbers selected from a segmentation SOP Instance.
- A list of Region of Interest (ROI) numbers selected from a radiotherapy structure set SOP Instance.; (xsd)subset:string>*
[]< Each imaging selection instance or frame list might includes an image region, specified by a region type and a set of 2D coordinates.
If the parent imagingSelection.instance contains a subset element of type frame, the image region applies to all frames in the subset list.; (xsd)imageRegion2D:ImagingSelection.instance.imageRegion2D>*
[]< Each imaging selection might includes a 3D image region, specified by a region type and a set of 3D coordinates.; (xsd)imageRegion3D:ImagingSelection.instance.imageRegion3D>*🔗 Each imaging selection instance or frame list might includes an image region, specified by a region type and a set of 2D coordinates.
If the parent imagingSelection.instance contains a subset element of type frame, the image region applies to all frames in the subset list.ImagingSelection.instance.imageRegion2D(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Specifies the type of image region. See [DICOM PS3.3 C.10.5.1.2](https://dicom.nema.org/medical/dicom/current/output/chtml/part03/sect_C.10.5.html#sect_C.10.5.1.2). Binding: imagingselection-2dgraphictype (required, The type of image region.); (xsd)regionType:code>
[]< The coordinates describing the image region. Encoded as a set of (column, row) pairs that denote positions in the selected image / frames specified with sub-pixel resolution.
The origin at the TLHC of the TLHC pixel is 0.0\0.0, the BRHC of the TLHC pixel is 1.0\1.0, and the BRHC of the BRHC pixel is the number of columns\rows in the image / frames. The values must be within the range 0\0 to the number of columns\rows in the image / frames. For a description of how 2D coordinates are encoded, see [DICOM PS3.3 C.18.6](http://dicom.nema.org/medical/dicom/current/output/chtml/part03/sect_C.18.6.html).; (xsd)coordinate:decimal>+🔗 Each imaging selection might includes a 3D image region, specified by a region type and a set of 3D coordinates.ImagingSelection.instance.imageRegion3D(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Specifies the type of image region. See [DICOM PS3.3 C.18.9.1.2](http://dicom.nema.org/medical/dicom/current/output/chtml/part03/sect_C.18.9.html#sect_C.18.9.1.2). Binding: imagingselection-3dgraphictype (required, The type of image region.); (xsd)regionType:code>
[]< The coordinates describing the image region. Encoded as an ordered set of (x,y,z) triplets (in mm and may be negative) that define a region of interest in the patient-relative Reference Coordinate System defined by ImagingSelection.frameOfReferenceUid element. For a description of how 3D coordinates are encoded, see [DICOM PS3.3 C.18.9](http://dicom.nema.org/medical/dicom/current/output/chtml/part03/sect_C.18.9.html).; (xsd)coordinate:decimal>+🔗 Selector of the instances – human or machine.ImagingSelection.performer(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Distinguishes the type of involvement of the performer. Binding: series-performer-function (extensible, The type of involvement of the performer.); (xsd)function:CodeableConcept>?
< Author – human or machine.; (xsd)actor:(<CareTeam>
|<Device>
|<HealthcareService>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>?🔗 Representation of the content produced in a DICOM imaging study. A study comprises a set of series, each of which includes a set of Service-Object Pair Instances (SOP Instances - images or other data) acquired or produced in a common context. A series is of only one modality (e.g. X-ray, CT, MR, ultrasound), but a study may have multiple series of different modalities.ImagingStudy(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< Identifiers for the ImagingStudy such as DICOM Study Instance UID. See discussion under [Imaging Study Implementation Notes](imagingstudy.html#notes) for encoding of DICOM Study Instance UID. ; (xsd)identifier:Identifier>*
< The current state of the ImagingStudy resource. This is not the status of any ServiceRequest or Task resources associated with the ImagingStudy. Unknown does not represent "other" - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is. Binding: imagingstudy-status (required, The status of the ImagingStudy.); (xsd)status:code>
[]< A list of all the distinct values of series.modality. This may include both acquisition and non-acquisition modalities. Binding: http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_33.html (extensible, Type of acquired data in the instance.); (xsd)modality:CodeableConcept>*
< The subject, typically a patient, of the imaging study. QA phantoms can be recorded with a Device; multiple subjects (such as mice) can be recorded with a Group.; (xsd)subject:(<Device>
|<Group>
|<Patient>)>
< The healthcare event (e.g. a patient and healthcare provider interaction) during which this ImagingStudy is made. This will typically be the encounter the event occurred within, but some events may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission test).; (xsd)encounter:Encounter*>?
< Date and time the study started.; (xsd)started:dateTime>?
[]< A list of the diagnostic requests that resulted in this imaging study being performed.; (xsd)basedOn:(<Appointment>
|<AppointmentResponse>
|<CarePlan>
|<ServiceRequest>
|<Task>)>*
[]< A larger event of which this particular ImagingStudy is a component or step. For example, an ImagingStudy as part of a procedure. To link an ImagingStudy to an Encounter use `encounter`.; (xsd)partOf:Procedure*>*
< The requesting/referring physician.; (xsd)referrer:(<Practitioner>
|<PractitionerRole>)>?
[]< The network service providing access (e.g., query, view, or retrieval) for the study. See implementation notes for information about using DICOM endpoints. A study-level endpoint applies to each series in the study, unless overridden by a series-level endpoint with the same Endpoint.connectionType. Typical endpoint types include DICOM WADO-RS, which is used to retrieve DICOM instances in native or rendered (e.g., JPG, PNG), formats using a RESTful API; DICOM WADO-URI, which can similarly retrieve native or rendered instances, except using an HTTP query-based approach; DICOM QIDO-RS, which allows RESTful query for DICOM information without retrieving the actual instances; or IHE Invoke Image Display (IID), which provides standard invocation of an imaging web viewer.; (xsd)endpoint:Endpoint*>*
< Number of Series in the Study. This value given may be larger than the number of series elements this Resource contains due to resource availability, security, or other factors. This element should be present if any series elements are present.; (xsd)numberOfSeries:unsignedInt>?
< Number of SOP Instances in Study. This value given may be larger than the number of instance elements this resource contains due to resource availability, security, or other factors. This element should be present if any instance elements are present.; (xsd)numberOfInstances:unsignedInt>?
[]< This field corresponds to the DICOM Procedure Code Sequence (0008,1032). This is different from the FHIR Procedure resource that may include the ImagingStudy. Binding: http://loinc.org/vs/loinc-rsna-radiology-playbook (preferred, Use of RadLex is preferred); (xsd)procedure:(<ActivityDefinition>
|<PlanDefinition>)>*
< The principal physical location where the ImagingStudy was performed.; (xsd)location:Location*>?
[]< Description of clinical condition indicating why the ImagingStudy was requested, and/or Indicates another resource whose existence justifies this Study. Binding: procedure-reason (example, The reason for the study.); (xsd)reason:(<Condition>
|<DiagnosticReport>
|<DocumentReference>
|<Observation>)>*
[]< Per the recommended DICOM mapping, this element is derived from the Study Description attribute (0008,1030). Observations or findings about the imaging study should be recorded in another resource, e.g. Observation, and not in this element.; (xsd)note:Annotation>*
< The Imaging Manager description of the study. Institution-generated description or classification of the Study (component) performed.; (xsd)description:string>?
[]< Each study has one or more series of images or other content.; (xsd)series:ImagingStudy.series>*🔗 Each study has one or more series of images or other content.ImagingStudy.series(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The DICOM Series Instance UID for the series. See [DICOM PS3.3 C.7.3](http://dicom.nema.org/medical/dicom/current/output/chtml/part03/sect_C.7.3.html).; (xsd)uid:id>
< The numeric identifier of this series in the study.; (xsd)number:unsignedInt>?
< The distinct modality for this series. This may include both acquisition and non-acquisition modalities. Binding: http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_33.html (extensible, Type of acquired data in the instance.); (xsd)modality:CodeableConcept>
< A description of the series.; (xsd)description:string>?
< Number of SOP Instances in the Study. The value given may be larger than the number of instance elements this resource contains due to resource availability, security, or other factors. This element should be present if any instance elements are present.; (xsd)numberOfInstances:unsignedInt>?
[]< The network service providing access (e.g., query, view, or retrieval) for this series. See implementation notes for information about using DICOM endpoints. A series-level endpoint, if present, has precedence over a study-level endpoint with the same Endpoint.connectionType. Typical endpoint types include DICOM WADO-RS, which is used to retrieve DICOM instances in native or rendered (e.g., JPG, PNG) formats using a RESTful API; DICOM WADO-URI, which can similarly retrieve native or rendered instances, except using an HTTP query-based approach; and DICOM QIDO-RS, which allows RESTful query for DICOM information without retrieving the actual instances.; (xsd)endpoint:Endpoint*>*
< The anatomic structures examined. See DICOM Part 16 Annex L (http://dicom.nema.org/medical/dicom/current/output/chtml/part16/chapter_L.html) for DICOM to SNOMED-CT mappings. The bodySite may indicate the laterality of body part imaged; if so, it shall be consistent with any content of ImagingStudy.series.laterality. Binding: body-site (example, SNOMED CT Body site concepts); (xsd)bodySite:BodyStructure*>?
< The laterality of the (possibly paired) anatomic structures examined. E.g., the left knee, both lungs, or unpaired abdomen. If present, shall be consistent with any laterality information indicated in ImagingStudy.series.bodySite. Binding: http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_244.html (example, Codes describing body site laterality (left, right, etc.).); (xsd)laterality:CodeableConcept>?
[]< The specimen imaged, e.g., for whole slide imaging of a biopsy.; (xsd)specimen:Specimen*>*
< The date and time the series was started.; (xsd)started:dateTime>?
[]< Indicates who or what performed the series and how they were involved. If the person who performed the series is not known, their Organization may be recorded. A patient, or related person, may be the performer, e.g. for patient-captured images.; (xsd)performer:ImagingStudy.series.performer>*
[]< A single SOP instance within the series, e.g. an image, or presentation state.; (xsd)instance:ImagingStudy.series.instance>*🔗 A single SOP instance within the series, e.g. an image, or presentation state.ImagingStudy.series.instance(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The DICOM SOP Instance UID for this image or other DICOM content. See [DICOM PS3.3 C.12.1](http://dicom.nema.org/medical/dicom/current/output/chtml/part03/sect_C.12.html#sect_C.12.1).; (xsd)uid:id>
< DICOM instance type. Binding: http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1 (extensible, The sopClass for the instance.); (xsd)sopClass:Coding>
< The number of instance in the series.; (xsd)number:unsignedInt>?
< The description of the instance. Particularly for post-acquisition analytic objects, such as SR, presentation states, value mapping, etc.; (xsd)title:string>?🔗 Indicates who or what performed the series and how they were involved. If the person who performed the series is not known, their Organization may be recorded. A patient, or related person, may be the performer, e.g. for patient-captured images.ImagingStudy.series.performer(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Distinguishes the type of involvement of the performer in the series. Binding: series-performer-function (extensible, The type of involvement of the performer.); (xsd)function:CodeableConcept>?
< Indicates who or what performed the series.; (xsd)actor:(<CareTeam>
|<Device>
|<HealthcareService>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>🔗 Describes the event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party.Immunization(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< A unique identifier assigned to this immunization record.; (xsd)identifier:Identifier>*
[]< A plan, order or recommendation fulfilled in whole or in part by this immunization. Allows tracing of an authorization for the Immunization.; (xsd)basedOn:(<CarePlan>
|<ImmunizationRecommendation>
|<MedicationRequest>
|<ServiceRequest>)>*
< Indicates the current status of the immunization event. Will generally be set to show that the immunization has been completed or not done. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. Binding: immunization-status (required, x); (xsd)status:code>
< Indicates the reason the immunization event was not performed. This is generally only used for the status of "not-done". The reason for performing the immunization event is captured in reasonCode, not here. Binding: immunization-status-reason (example, x); (xsd)statusReason:CodeableConcept>?
< Vaccine that was administered or was to be administered. The code for the administered vaccine may be reported at various levels of granularity from a very generic code for a general type of vaccine (e.g. the SNOMED or CVX code for the flu vaccine) to a very discrete code for a specific product including the form and packaging (e.g. an NDC code). Because vaccineCode uses the CodeableConcept data type, multiple codes at different levels of granularity may be reported for a single immunization event provided that all codes are appropriate for the same vaccine. For example, both NDC and CVX codes may be provided for a given immunization event by repeating the coding element within vaccineCode. Binding: vaccine-code (example, x); (xsd)vaccineCode:CodeableConcept>
< An indication of which product was administered to the patient. This is typically a more detailed representation of the concept conveyed by the vaccineCode data element. If a Medication resource is referenced, it may be to a stand-alone resource or a contained resource within the Immunization resource.; (xsd)administeredProduct:Medication*>?
< Name of vaccine manufacturer.; (xsd)manufacturer:Organization*>?
< Lot number of the vaccine product.; (xsd)lotNumber:string>?
< Date vaccine batch expires.; (xsd)expirationDate:date>?
< The patient who either received or did not receive the immunization.; (xsd)patient:Patient*>
< The visit or admission or other contact between patient and health care provider the immunization was performed as part of.; (xsd)encounter:Encounter*>?
[]< Additional information that is relevant to the immunization (e.g. for a vaccine recipient who is pregnant, the gestational age of the fetus). The reason why a vaccine was given (e.g. occupation, underlying medical condition) should be conveyed in Immunization.reason, not as supporting information. The reason why a vaccine was not given (e.g. contraindication) should be conveyed in Immunization.statusReason, not as supporting information.; (xsd)supportingInformation:Resource*>*
< Date vaccine administered or was to be administered. When immunizations are given a specific date and time should always be known. When immunizations are patient reported, a specific date might not be known. Although partial dates are allowed, an adult patient might not be able to recall the year a childhood immunization was given. An exact date is always preferable, but the use of the String data type is acceptable when an exact date is not known. A small number of vaccines (e.g. live oral typhoid vaccine) are given as a series of patient self-administered dose over a span of time. In cases like this, often, only the first dose (typically a provider supervised dose) is recorded with the occurrence indicating the date/time of the first dose.; (xsd)occurrence:(<dateTime>
|<string>)>
< Indicates whether the data contained in the resource was captured by the individual/organization which was responsible for the administration of the vaccine rather than as 'secondary reported' data documented by a third party. A value of 'true' means this data originated with the individual/organization which was responsible for the administration of the vaccine. Reflects the “reliability” of the content.; (xsd)primarySource:boolean>?
< Typically the source of the data when the report of the immunization event is not based on information from the person who administered the vaccine. Typically will not be populated if primarySource = True, not required even if primarySource = False. Binding: immunization-origin (example, x); (xsd)informationSource:(<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>?
< The service delivery location where the vaccine administration occurred.; (xsd)location:Location*>?
< Body site where vaccine was administered. Binding: immunization-site (example, x); (xsd)site:CodeableConcept>?
< The path by which the vaccine product is taken into the body. Binding: immunization-route (example, x); (xsd)route:CodeableConcept>?
< The quantity of vaccine product that was administered.; (xsd)doseQuantity:SimpleQuantity>?
[]< Indicates who performed the immunization event.; (xsd)performer:Immunization.performer>*
[]< Extra information about the immunization that is not conveyed by the other attributes.; (xsd)note:Annotation>*
[]< Describes why the immunization occurred in coded or textual form, or Indicates another resource (Condition, Observation or DiagnosticReport) whose existence justifies this immunization. Binding: immunization-reason (example, x); (xsd)reason:(<Condition>
|<DiagnosticReport>
|<Observation>)>*
< Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent. Typically, the recognition of the dose being sub-potent is retrospective, after the administration (ex. notification of a manufacturer recall after administration). However, in the case of a partial administration (the patient moves unexpectedly and only some of the dose is actually administered), subpotency may be recognized immediately, but it is still important to record the event.; (xsd)isSubpotent:boolean>?
[]< Reason why a dose is considered to be subpotent. Binding: immunization-subpotent-reason (example, The reason why a dose is considered to be subpotent.); (xsd)subpotentReason:CodeableConcept>*
[]< Indicates a patient's eligibility for a funding program.; (xsd)programEligibility:Immunization.programEligibility>*
< Indicates the source of the vaccine actually administered. This may be different than the patient eligibility (e.g. the patient may be eligible for a publically purchased vaccine but due to inventory issues, vaccine purchased with private funds was actually administered). Binding: immunization-funding-source (example, x); (xsd)fundingSource:CodeableConcept>?
[]< Categorical data indicating that an adverse event is associated in time to an immunization. A reaction may be an indication of an allergy or intolerance and, if this is determined to be the case, it should be recorded as a new AllergyIntolerance resource instance as most systems will not query against past Immunization.reaction elements.; (xsd)reaction:Immunization.reaction>*
[]< The protocol (set of recommendations) being followed by the provider who administered the dose.; (xsd)protocolApplied:Immunization.protocolApplied>*🔗 Indicates who performed the immunization event.Immunization.performer(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Describes the type of performance (e.g. ordering provider, administering provider, etc.). Binding: immunization-function (extensible, x); (xsd)function:CodeableConcept>?
< The practitioner or organization who performed the action. When the individual practitioner who performed the action is known, it is best to send.; (xsd)actor:(<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>🔗 Indicates a patient's eligibility for a funding program.Immunization.programEligibility(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Indicates which program the patient had their eligility evaluated for. Binding: immunization-vaccine-funding-program (example, x); (xsd)program:CodeableConcept>
< Indicates the patient's eligility status for for a specific payment program. Binding: immunization-program-eligibility (example, x); (xsd)programStatus:CodeableConcept>🔗 The protocol (set of recommendations) being followed by the provider who administered the dose.Immunization.protocolApplied(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< One possible path to achieve presumed immunity against a disease - within the context of an authority.; (xsd)series:string>?
< Indicates the authority who published the protocol (e.g. ACIP) that is being followed.; (xsd)authority:Organization*>?
[]< The vaccine preventable disease the dose is being administered against. Binding: immunization-target-disease (example, x); (xsd)targetDisease:CodeableConcept>*
< Nominal position in a series as intended by the practitioner administering the dose. The use of an integer is preferred if known. Text should only be used in cases where an integer is not available (such as when documenting a recurring booster dose).; (xsd)doseNumber:string>
< The recommended number of doses to achieve immunity as intended by the practitioner administering the dose. The use of an integer is preferred if known.; (xsd)seriesDoses:string>?🔗 Categorical data indicating that an adverse event is associated in time to an immunization. A reaction may be an indication of an allergy or intolerance and, if this is determined to be the case, it should be recorded as a new AllergyIntolerance resource instance as most systems will not query against past Immunization.reaction elements.Immunization.reaction(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Date of reaction to the immunization.; (xsd)date:dateTime>?
< Details of the reaction.; (xsd)manifestation:Observation*>?
< Self-reported indicator.; (xsd)reported:boolean>?🔗 Describes a comparison of an immunization event against published recommendations to determine if the administration is "valid" in relation to those recommendations.ImmunizationEvaluation(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< A unique identifier assigned to this immunization evaluation record.; (xsd)identifier:Identifier>*
< Indicates the current status of the evaluation of the vaccination administration event. Binding: immunization-evaluation-status (required, The status of the evaluation being done.); (xsd)status:code>
< The individual for whom the evaluation is being done.; (xsd)patient:Patient*>
< The date the evaluation of the vaccine administration event was performed.; (xsd)date:dateTime>?
< Indicates the authority who published the protocol (e.g. ACIP).; (xsd)authority:Organization*>?
< The vaccine preventable disease the dose is being evaluated against. Binding: immunization-target-disease (example, The vaccine preventable disease the dose is being evaluated against.); (xsd)targetDisease:CodeableConcept>
< The vaccine administration event being evaluated.; (xsd)immunizationEvent:Immunization*>
< Indicates if the dose is valid or not valid with respect to the published recommendations. Binding: immunization-evaluation-dose-status (example, The status of the administered dose relative to the published recommendations for the target disease.); (xsd)doseStatus:CodeableConcept>
[]< Provides an explanation as to why the vaccine administration event is valid or not relative to the published recommendations. Binding: immunization-evaluation-dose-status-reason (example, The reason the dose status was assigned.); (xsd)doseStatusReason:CodeableConcept>*
< Additional information about the evaluation.; (xsd)description:markdown>?
< One possible path to achieve presumed immunity against a disease - within the context of an authority.; (xsd)series:string>?
< Nominal position in a series as determined by the outcome of the evaluation process. The use of an integer is preferred if known. A string should only be used in cases where an integer is not available (such as when documenting a recurring booster dose).; (xsd)doseNumber:string>?
< The recommended number of doses to achieve immunity as determined by the outcome of the evaluation process. The use of an integer is preferred if known.; (xsd)seriesDoses:string>?🔗 A patient's point-in-time set of recommendations (i.e. forecasting) according to a published schedule with optional supporting justification.ImmunizationRecommendation(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< A unique identifier assigned to this particular recommendation record.; (xsd)identifier:Identifier>*
< The patient the recommendation(s) are for.; (xsd)patient:Patient*>
< The date the immunization recommendation(s) were created.; (xsd)date:dateTime>
< Indicates the authority who published the protocol (e.g. ACIP).; (xsd)authority:Organization*>?
[]< Vaccine administration recommendations. A given instance of the .recommendation backbone element should correspond to a single recommended administration.; (xsd)recommendation:ImmunizationRecommendation.recommendation>+🔗 Vaccine administration recommendations. A given instance of the .recommendation backbone element should correspond to a single recommended administration.ImmunizationRecommendation.recommendation(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< Vaccine(s) or vaccine group that pertain to the recommendation. Binding: vaccine-code (example, The type of vaccine administered.); (xsd)vaccineCode:CodeableConcept>*
[]< The targeted disease for the recommendation. A given instance of the .recommendation backbone element should correspond to a single recommended administration but sometimes that administration (e.g. MMR) will encompass multiple diseases, thus the targetDisease element is allowed to repeat. Binding: immunization-target-disease (example, The disease that the recommended vaccination targets.); (xsd)targetDisease:CodeableConcept>*
[]< Vaccine(s) which should not be used to fulfill the recommendation. Binding: vaccine-code (example, The type of vaccine administered.); (xsd)contraindicatedVaccineCode:CodeableConcept>*
< Indicates the patient status with respect to the path to immunity for the target disease. Binding: immunization-recommendation-status (example, The patient's status with respect to a vaccination protocol.); (xsd)forecastStatus:CodeableConcept>
[]< The reason for the assigned forecast status. Binding: immunization-recommendation-reason (example, The reason for the patient's status with respect to a vaccination protocol.); (xsd)forecastReason:CodeableConcept>*
[]< Vaccine date recommendations. For example, earliest date to administer, latest date to administer, etc.; (xsd)dateCriterion:ImmunizationRecommendation.recommendation.dateCriterion>*
< Contains the description about the protocol under which the vaccine was administered.; (xsd)description:markdown>?
< One possible path to achieve presumed immunity against a disease - within the context of an authority.; (xsd)series:string>?
< Nominal position of the recommended dose in a series as determined by the evaluation and forecasting process (e.g. dose 2 is the next recommended dose). The use of an integer is preferred if known. A string should only be used in cases where an integer is not available (such as when documenting a recurring booster dose).; (xsd)doseNumber:string>?
< The recommended number of doses to achieve immunity as determined by the evaluation and forecasting process. The use of an integer is preferred if known.; (xsd)seriesDoses:string>?
[]< Immunization event history and/or evaluation that supports the status and recommendation.; (xsd)supportingImmunization:(<Immunization>
|<ImmunizationEvaluation>)>*
[]< Patient Information that supports the status and recommendation. This includes patient observations, adverse reactions and allergy/intolerance information.; (xsd)supportingPatientInformation:Resource*>*🔗 Vaccine date recommendations. For example, earliest date to administer, latest date to administer, etc.ImmunizationRecommendation.recommendation.dateCriterion(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Date classification of recommendation. For example, earliest date to give, latest date to give, etc. Binding: immunization-recommendation-date-criterion (example, Classifies date criterion with respect to conveying information about a patient's vaccination status (e.g. due date, latest to give date, etc.).); (xsd)code:CodeableConcept>
< The date whose meaning is specified by dateCriterion.code.; (xsd)value:dateTime>🔗 A set of rules of how a particular interoperability or standards problem is solved - typically through the use of FHIR resources. This resource is used to gather all the parts of an implementation guide into a logical whole and to publish a computable definition of all the parts.ImplementationGuide(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< An absolute URI that is used to identify this implementation guide when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this implementation guide is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the implementation guide is stored on different servers. Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.
The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions).
In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.; (xsd)url:uri>
[]< A formal identifier that is used to identify this implementation guide when it is represented in other formats, or referenced in a specification, model, design or an instance.; (xsd)identifier:Identifier>*
< The identifier that is used to identify this version of the implementation guide when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the implementation guide author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. There may be different implementation guide instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the implementation guide with the format [url]|[version]. The version SHOULD NOT contain a '#' - see [Business Version](resource.html#bv-format).; (xsd)version:string>?
< Indicates the mechanism used to compare versions to determine which is more current. If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined. Binding: version-algorithm (extensible, ); (xsd)versionAlgorithm:(<Coding>
|<string>)>?
< A natural language name identifying the implementation guide. This name should be usable as an identifier for the module by machine processing applications such as code generation. The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.; (xsd)name:string>
< A short, descriptive, user-friendly title for the implementation guide. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.; (xsd)title:string>?
< The status of this implementation guide. Enables tracking the life-cycle of the content. Allows filtering of implementation guides that are appropriate for use versus not.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization). Binding: publication-status (required, The lifecycle status of an artifact.); (xsd)status:code>
< A Boolean value to indicate that this implementation guide is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. Allows filtering of implementation guides that are appropriate for use versus not.; (xsd)experimental:boolean>?
< The date (and optionally time) when the implementation guide was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the implementation guide changes. The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the implementation guide. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)date:dateTime>?
< The name of the organization or individual responsible for the release and ongoing maintenance of the implementation guide. Usually an organization but may be an individual. The publisher (or steward) of the implementation guide is the organization or individual primarily responsible for the maintenance and upkeep of the implementation guide. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the implementation guide. This item SHOULD be populated unless the information is available from context.; (xsd)publisher:string>?
[]< Contact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)contact:ContactDetail>*
< A free text natural language description of the implementation guide from a consumer's perspective. This description can be used to capture details such as why the implementation guide was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the implementation guide as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the implementation guide is presumed to be the predominant language in the place the implementation guide was created).; (xsd)description:markdown>?
[]< The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate implementation guide instances. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.; (xsd)useContext:UsageContext>*
[]< A legal or geographic region in which the implementation guide is intended to be used. It may be possible for the implementation guide to be used in jurisdictions other than those for which it was originally designed or intended.
DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.) Binding: jurisdiction (extensible, Countries and regions within which this artifact is targeted for use.); (xsd)jurisdiction:CodeableConcept>*
< Explanation of why this implementation guide is needed and why it has been designed as it has. This element does not describe the usage of the implementation guide. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this implementation guide.; (xsd)purpose:markdown>?
< A copyright statement relating to the implementation guide and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the implementation guide. ...; (xsd)copyright:markdown>?
< A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved'). The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.; (xsd)copyrightLabel:string>?
< The NPM package name for this Implementation Guide, used in the NPM package distribution, which is the primary mechanism by which FHIR based tooling manages IG dependencies. This value must be globally unique, and should be assigned with care. Many (if not all) IG publishing tools will require that this element be present. For implementation guides published through HL7 or the FHIR foundation, the FHIR product director assigns package IDs.; (xsd)packageId:id>
< The license that applies to this Implementation Guide, using an SPDX license code, or 'not-open-source'. Binding: spdx-license (required, The license that applies to an Implementation Guide (using an SPDX license Identifiers, or 'not-open-source'). The binding is required but new SPDX license Identifiers are allowed to be used (https://spdx.org/licenses/).); (xsd)license:code>?
[]< The version(s) of the FHIR specification that this ImplementationGuide targets - e.g. describes how to use. The value of this element is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 4.6.0. for this version. Most implementation guides target a single version - e.g. they describe how to use a particular version, and the profiles and examples etc. are valid for that version. But some implementation guides describe how to use multiple different versions of FHIR to solve the same problem, or in concert with each other. Typically, the requirement to support multiple versions arises as implementation matures and different implementation communities are stuck at different versions by regulation or market dynamics. Binding: FHIR-version (required, All published FHIR Versions.); (xsd)fhirVersion:code>+
[]< Another implementation guide that this implementation depends on. Typically, an implementation guide uses value sets, profiles etc.defined in other implementation guides.; (xsd)dependsOn:ImplementationGuide.dependsOn>*
[]< A set of profiles that all resources covered by this implementation guide must conform to. See [Default Profiles](implementationguide.html#default) for a discussion of which resources are 'covered' by an implementation guide.; (xsd)global:ImplementationGuide.global>*
< The information needed by an IG publisher tool to publish the whole implementation guide. Principally, this consists of information abuot source resource and file locations, and build parameters and templates.; (xsd)definition:ImplementationGuide.definition>?
< Information about an assembled implementation guide, created by the publication tooling.; (xsd)manifest:ImplementationGuide.manifest>?🔗 The information needed by an IG publisher tool to publish the whole implementation guide. Principally, this consists of information abuot source resource and file locations, and build parameters and templates.ImplementationGuide.definition(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< A logical group of resources. Logical groups can be used when building pages. Groupings are arbitrary sub-divisions of content. Typically, they are used to help build Table of Contents automatically.; (xsd)grouping:ImplementationGuide.definition.grouping>*
[]< A resource that is part of the implementation guide. Conformance resources (value set, structure definition, capability statements etc.) are obvious candidates for inclusion, but any kind of resource can be included as an example resource.; (xsd)resource:ImplementationGuide.definition.resource>*
< A page / section in the implementation guide. The root page is the implementation guide home page. Pages automatically become sections if they have sub-pages. By convention, the home page is called index.html.; (xsd)page:ImplementationGuide.definition.page>?
[]< A set of parameters that defines how the implementation guide is built. The parameters are defined by the relevant tools that build the implementation guides. see [confluence](https://confluence.hl7.org/display/FHIR/Implementation+Guide+Parameters) for the parameters defined by the HL7 IG publisher.; (xsd)parameter:ImplementationGuide.definition.parameter>*
[]< A template for building resources.; (xsd)template:ImplementationGuide.definition.template>*🔗 A logical group of resources. Logical groups can be used when building pages. Groupings are arbitrary sub-divisions of content. Typically, they are used to help build Table of Contents automatically.ImplementationGuide.definition.grouping(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The human-readable title to display for the package of resources when rendering the implementation guide.; (xsd)name:string>
< Human readable text describing the package.; (xsd)description:markdown>?🔗 A page / section in the implementation guide. The root page is the implementation guide home page. Pages automatically become sections if they have sub-pages. By convention, the home page is called index.html.ImplementationGuide.definition.page(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Indicates the URL or the actual content to provide for the page. If absent and the page isn't a generated page, this may be inferred from the page name by checking input locations. String is used for XHTML content - sent as an escaped string. FHIR tooling can't support 'direct' XHTML anywhere other than in narrative.; (xsd)source:(<markdown>
|<string>
|<url>)>?
< The url by which the page should be known when published. This SHALL be a local reference, expressed with respect to the root of the IG output folder. No suffix is required. If no suffix is specified, .html will be appended.; (xsd)name:url>
< A short title used to represent this page in navigational structures such as table of contents, bread crumbs, etc.; (xsd)title:string>
< A code that indicates how the page is generated. Binding: guide-page-generation (required, A code that indicates how the page is generated.); (xsd)generation:code>
[]< Nested Pages/Sections under this page. The implementation guide breadcrumbs may be generated from this structure.; (xsd)page:ImplementationGuide.definition.page>*🔗 A set of parameters that defines how the implementation guide is built. The parameters are defined by the relevant tools that build the implementation guides. see [confluence](https://confluence.hl7.org/display/FHIR/Implementation+Guide+Parameters) for the parameters defined by the HL7 IG publisher.ImplementationGuide.definition.parameter(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A tool-specific code that defines the parameter. Binding: guide-parameter-code (extensible, ); (xsd)code:Coding>
< Value for named type.; (xsd)value:string>🔗 A resource that is part of the implementation guide. Conformance resources (value set, structure definition, capability statements etc.) are obvious candidates for inclusion, but any kind of resource can be included as an example resource.ImplementationGuide.definition.resource(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Where this resource is found. Usually this is a relative URL that locates the resource within the implementation guide. If you authoring an implementation guide, and will publish it using the FHIR publication tooling, use a URI that may point to a resource, or to one of various alternative representations (e.g. spreadsheet). The tooling will convert this when it publishes it.; (xsd)reference:Resource*>
[]< Indicates the FHIR Version(s) this artifact is intended to apply to. If no versions are specified, the resource is assumed to apply to all the versions stated in ImplementationGuide.fhirVersion. The resource SHALL be valid against all the versions it is specified to apply to. If the resource referred to is a StructureDefinition, the fhirVersion stated in the StructureDefinition cannot disagree with the version specified here; the specified versions SHALL include the version specified by the StructureDefinition, and may include additional versions using the [http://hl7.org/fhir/StructureDefinition/structuredefinition-applicable-version](http://hl7.org/fhir/extensions/StructureDefinition-structuredefinition-applicable-version.html) extension. Binding: FHIR-version (required, All published FHIR Versions.); (xsd)fhirVersion:code>*
< A human assigned name for the resource. All resources SHOULD have a name, but the name may be extracted from the resource (e.g. ValueSet.name).; (xsd)name:string>?
< A description of the reason that a resource has been included in the implementation guide. This is mostly used with examples to explain why it is present (though they can have extensive comments in the examples).; (xsd)description:markdown>?
< If true, indicates the resource is an example instance.; (xsd)isExample:boolean>?
[]< If present, indicates profile(s) the instance is valid against. Examples:
* StructureDefinition -> Any
* ValueSet -> expansion
* OperationDefinition -> Parameters
* Questionnaire -> QuestionnaireResponse.; (xsd)profile:StructureDefinition*>*
< Reference to the id of the grouping this resource appears in. This must correspond to a group.id element within this implementation guide.; (xsd)groupingId:id>?🔗 A template for building resources.ImplementationGuide.definition.template(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Type of template specified.; (xsd)code>
< The source location for the template.; (xsd)source:string>
< The scope in which the template applies.; (xsd)scope:string>?🔗 Another implementation guide that this implementation depends on. Typically, an implementation guide uses value sets, profiles etc.defined in other implementation guides.ImplementationGuide.dependsOn(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A canonical reference to the Implementation guide for the dependency. Usually, A canonical reference to the implementation guide is the same as the master location at which the implementation guide is published.; (xsd)uri:ImplementationGuide*>
< The NPM package name for the Implementation Guide that this IG depends on.; (xsd)packageId:id>?
< The version of the IG that is depended on, when the correct version is required to understand the IG correctly. This follows the syntax of the NPM packaging version field - see [[reference]].; (xsd)version:string>?
< A description explaining the nature of the dependency on the listed IG. This doesn't need to enumerate every resource used, but should give some sense of why the dependency exists. It will be used in the rendered list of dependencies; (xsd)reason:markdown>?🔗 A set of profiles that all resources covered by this implementation guide must conform to. See [Default Profiles](implementationguide.html#default) for a discussion of which resources are 'covered' by an implementation guide.ImplementationGuide.global(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The type of resource that all instances must conform to. The type must match that of the profile that is referred to but is made explicit here as a denormalization so that a system processing the implementation guide resource knows which resources the profile applies to even if the profile itself is not available. Binding: resource-types (required, One of the resource types defined as part of this version of FHIR.); (xsd)type:code>
< A reference to the profile that all instances must conform to.; (xsd)profile:StructureDefinition*>🔗 Information about an assembled implementation guide, created by the publication tooling.ImplementationGuide.manifest(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A pointer to official web page, PDF or other rendering of the implementation guide.; (xsd)rendering:url>?
[]< A resource that is part of the implementation guide. Conformance resources (value set, structure definition, capability statements etc.) are obvious candidates for inclusion, but any kind of resource can be included as an example resource.; (xsd)resource:ImplementationGuide.manifest.resource>+
[]< Information about a page within the IG.; (xsd)page:ImplementationGuide.manifest.page>*
[]< Indicates a relative path to an image that exists within the IG.; (xsd)image:string>*
[]< Indicates the relative path of an additional non-page, non-image file that is part of the IG - e.g. zip, jar and similar files that could be the target of a hyperlink in a derived IG.; (xsd)other:string>*🔗 Information about a page within the IG.ImplementationGuide.manifest.page(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Relative path to the page. Appending 'rendering' + "/" + this should resolve to the page.; (xsd)name:string>
< Label for the page intended for human display.; (xsd)title:string>?
[]< The name of an anchor available on the page. Appending 'rendering' + "/" + page.name + "#" + page.anchor should resolve to the anchor.; (xsd)anchor:string>*🔗 A resource that is part of the implementation guide. Conformance resources (value set, structure definition, capability statements etc.) are obvious candidates for inclusion, but any kind of resource can be included as an example resource.ImplementationGuide.manifest.resource(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Where this resource is found. Usually this is a relative URL that locates the resource within the implementation guide. If you authoring an implementation guide, and will publish it using the FHIR publication tooling, use a URI that may point to a resource, or to one of various alternative representations (e.g. spreadsheet). The tooling will convert this when it publishes it.; (xsd)reference:Resource*>
< If true, indicates the resource is an example instance.; (xsd)isExample:boolean>?
[]< If present, indicates profile(s) the instance is valid against. Examples:
* StructureDefinition -> Any
* ValueSet -> expansion
* OperationDefinition -> Parameters
* Questionnaire -> QuestionnaireResponse.; (xsd)profile:StructureDefinition*>*
< The relative path for primary page for this resource within the IG. Appending 'rendering' + "/" + this should resolve to the resource page.; (xsd)relativePath:url>?🔗 A single issue - either an indication, contraindication, interaction or an undesirable effect for a medicinal product, medication, device or procedure.IndicationDefinition(xsd)(doc)=
<#base:ClinicalUseDefinition>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< Business identifier for this issue.; (xsd)identifier:Identifier>*
< indication | contraindication | interaction | undesirable-effect | warning. Binding: clinical-use-definition-type (required, Overall defining type of this clinical use definition.) indication; (xsd)type:code>
[]< A categorisation of the issue, primarily for dividing warnings into subject heading areas such as "Pregnancy and Lactation", "Overdose", "Effects on Ability to Drive and Use Machines". Binding: clinical-use-definition-category (preferred, A categorisation for a clinical use information item.); (xsd)category:CodeableConcept>*
[]< The medication, product, substance, device, procedure etc. for which this is an indication.; (xsd)subject:(<ActivityDefinition>
|<BiologicallyDerivedProduct>
|<Device>
|<DeviceDefinition>
|<Medication>
|<MedicinalProductDefinition>
|<NutritionProduct>
|<PlanDefinition>
|<Substance>)>*
< Whether this is a current issue or one that has been retired etc. Binding: publication-status (preferred, The lifecycle status of an artifact.); (xsd)status:CodeableConcept>?
< Specifics for when this is a contraindication.; (xsd)contraindication:IndicationDefinition.contraindication>{0,0}
< Specifics for when this is an indication.; (xsd)indication:IndicationDefinition.indication>
< Specifics for when this is an interaction.; (xsd)interaction:IndicationDefinition.interaction>{0,0}
[]< The population group to which this applies.; (xsd)population:Group*>*
[]< Logic used by the clinical use definition.; (xsd)library:Library*>*
< Describe the possible undesirable effects (negative outcomes) from the use of the medicinal product as treatment.; (xsd)undesirableEffect:IndicationDefinition.undesirableEffect>{0,0}
< A critical piece of information about environmental, health or physical risks or hazards that serve as caution to the user. For example 'Do not operate heavy machinery', 'May cause drowsiness', or 'Get medical advice/attention if you feel unwell'.; (xsd)warning:IndicationDefinition.warning>{0,0}🔗 Specifics for when this is a contraindication.IndicationDefinition.contraindication(xsd)(doc)=
<#base:ClinicalUseDefinition.contraindication>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The situation that is being documented as contraindicating against this item. Binding: disease-symptom-procedure (example, A symptom, disease or procedure.); (xsd)diseaseSymptomProcedure:ObservationDefinition*>?
< The status of the disease or symptom for the contraindication, for example "chronic" or "metastatic". Binding: disease-status (example, The status of a disease or symptom.); (xsd)diseaseStatus:ObservationDefinition*>?
[]< A comorbidity (concurrent condition) or coinfection. Binding: disease-symptom-procedure (example, A symptom, disease or procedure.); (xsd)comorbidity:ObservationDefinition*>*
[]< The indication which this is a contraidication for.; (xsd)indication:ClinicalUseDefinition*>*
< An expression that returns true or false, indicating whether the indication is applicable or not, after having applied its other elements. The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.; (xsd)applicability:Expression>?
[]< Information about the use of the medicinal product in relation to other therapies described as part of the contraindication.; (xsd)otherTherapy:IndicationDefinition.contraindication.otherTherapy>*🔗 Information about the use of the medicinal product in relation to other therapies described as part of the contraindication.IndicationDefinition.contraindication.otherTherapy(xsd)(doc)=
<#base:ClinicalUseDefinition.contraindication.otherTherapy>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The type of relationship between the medicinal product indication or contraindication and another therapy. Binding: therapy-relationship-type (preferred, Classification of relationship between a therapy and a contraindication or an indication.); (xsd)relationshipType:CodeableConcept>
< Reference to a specific medication (active substance, medicinal product or class of products, biological, food etc.) as part of an indication or contraindication. Binding: therapy (example, A therapy.); (xsd)treatment:(<ActivityDefinition>
|<BiologicallyDerivedProduct>
|<Medication>
|<MedicinalProductDefinition>
|<NutritionProduct>
|<Substance>
|<SubstanceDefinition>)>🔗 Specifics for when this is an indication.IndicationDefinition.indication(xsd)(doc)=
<#base:ClinicalUseDefinition.indication>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The situation that is being documented as an indicaton for this item. Binding: disease-symptom-procedure (example, A symptom, disease or procedure.); (xsd)diseaseSymptomProcedure:ObservationDefinition*>?
< The status of the disease or symptom for the indication, for example "chronic" or "metastatic". Binding: disease-status (example, The status of a disease or symptom.); (xsd)diseaseStatus:ObservationDefinition*>?
[]< A comorbidity (concurrent condition) or coinfection as part of the indication. Binding: disease-symptom-procedure (example, A symptom, disease or procedure.); (xsd)comorbidity:ObservationDefinition*>*
< The intended effect, aim or strategy to be achieved. Binding: product-intended-use (preferred, The overall intended use of a product.); (xsd)intendedEffect:ObservationDefinition*>?
< Timing or duration information, that may be associated with use with the indicated condition e.g. Adult patients suffering from myocardial infarction (from a few days until less than 35 days), ischaemic stroke (from 7 days until less than 6 months).; (xsd)duration:(<Range>
|<string>)>?
[]< An unwanted side effect or negative outcome that may happen if you use the drug (or other subject of this resource) for this indication.; (xsd)undesirableEffect:ClinicalUseDefinition*>*
< An expression that returns true or false, indicating whether the indication is applicable or not, after having applied its other elements. The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.; (xsd)applicability:Expression>?
[]< Information about the use of the medicinal product in relation to other therapies described as part of the indication.; (xsd)otherTherapy:ClinicalUseDefinition.contraindication.otherTherapy>*🔗 Specifics for when this is an interaction.IndicationDefinition.interaction(xsd)(doc)=
<#base:ClinicalUseDefinition.interaction>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< The specific medication, product, food, substance etc. or laboratory test that interacts.; (xsd)interactant:IndicationDefinition.interaction.interactant>*
< The type of the interaction e.g. drug-drug interaction, drug-food interaction, drug-lab test interaction. Binding: interaction-type (example, A categorisation for an interaction between two substances.); (xsd)type:CodeableConcept>?
< The effect of the interaction, for example "reduced gastric absorption of primary medication". Binding: interaction-effect (example, A interaction effect of clinical use of a medication or other substance.); (xsd)effect:ObservationDefinition*>?
< The incidence of the interaction, e.g. theoretical, observed. Binding: interaction-incidence (example, A categorisation for incidence of occurence of an interaction.); (xsd)incidence:CodeableConcept>?
[]< Actions for managing the interaction. Binding: interaction-management (example, A type of management for an interaction of a medication or other substance.); (xsd)management:CodeableConcept>*🔗 The specific medication, product, food, substance etc. or laboratory test that interacts.IndicationDefinition.interaction.interactant(xsd)(doc)=
<#base:ClinicalUseDefinition.interaction.interactant>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The specific medication, product, food, substance etc. or laboratory test that interacts. Binding: interactant (example, An interactant - a substance that may have a clinically significant effect on another.); (xsd)item:(<BiologicallyDerivedProduct>
|<CodeableConcept>
|<Medication>
|<MedicinalProductDefinition>
|<NutritionProduct>
|<ObservationDefinition>
|<Substance>)>🔗 Describe the possible undesirable effects (negative outcomes) from the use of the medicinal product as treatment.IndicationDefinition.undesirableEffect(xsd)(doc)=
<#base:ClinicalUseDefinition.undesirableEffect>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The situation in which the undesirable effect may manifest. Binding: undesirable-effect-symptom (example, An undesirable effect of clinical use.); (xsd)symptomConditionEffect:ObservationDefinition*>?
< High level classification of the effect. Binding: undesirable-effect-classification (example, A categorisation for an undesirable effect.); (xsd)classification:CodeableConcept>?
< How often the effect is seen. Binding: undesirable-effect-frequency (example, A categorisation for a frequency of occurence of an undesirable effect.); (xsd)frequencyOfOccurrence:CodeableConcept>?🔗 A critical piece of information about environmental, health or physical risks or hazards that serve as caution to the user. For example 'Do not operate heavy machinery', 'May cause drowsiness', or 'Get medical advice/attention if you feel unwell'.IndicationDefinition.warning(xsd)(doc)=
<#base:ClinicalUseDefinition.warning>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A textual definition of this warning, with formatting.; (xsd)description:markdown>?
< A coded or unformatted textual definition of this warning. Binding: warning-type (example, Classification of warning type.); (xsd)code:CodeableConcept>?🔗 An ingredient of a manufactured item or pharmaceutical product.Ingredient(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< The identifier(s) of this Ingredient that are assigned by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate.; (xsd)identifier:Identifier>?
< The status of this ingredient. Enables tracking the life-cycle of the content. Allows filtering of ingredient that are appropriate for use versus not. Binding: publication-status (required, The lifecycle status of an artifact.); (xsd)status:code>
[]< The product which this ingredient is a constituent part of.; (xsd)for:(<AdministrableProductDefinition>
|<ManufacturedItemDefinition>
|<MedicinalProductDefinition>)>*
< A classification of the ingredient identifying its purpose within the product, e.g. active, inactive. Binding: ingredient-role (example, A classification of the ingredient identifying its purpose within the product, e.g. active, inactive.); (xsd)role:CodeableConcept>
[]< A classification of the ingredient identifying its precise purpose(s) in the drug product. This extends the Ingredient.role to add more detail. Example: antioxidant, alkalizing agent. Binding: ingredient-function (example, A classification of the ingredient identifying its precise purpose(s) in the drug product (beyond e.g. active/inactive).); (xsd)function:CodeableConcept>*
< A classification of the ingredient according to where in the physical item it tends to be used, such the outer shell of a tablet, inner body or ink.; (xsd)group:CodeableConcept>?
< If the ingredient is a known or suspected allergen. Note that this is a property of the substance, so if a reference to a SubstanceDefinition is used to decribe that (rather than just a code), the allergen information should go there, not here.; (xsd)allergenicIndicator:boolean>?
< A place for providing any notes that are relevant to the component, e.g. removed during process, adjusted for loss on drying.; (xsd)comment:markdown>?
[]< The organization(s) that manufacture this ingredient. Can be used to indicate: 1) Organizations we are aware of that manufacture this ingredient 2) Specific Manufacturer(s) currently being used 3) Set of organisations allowed to manufacture this ingredient for this product Users must be clear on the application of context relevant to their use case.; (xsd)manufacturer:Ingredient.manufacturer>*
< The substance that comprises this ingredient.; (xsd)substance:Ingredient.substance>🔗 The organization(s) that manufacture this ingredient. Can be used to indicate: 1) Organizations we are aware of that manufacture this ingredient 2) Specific Manufacturer(s) currently being used 3) Set of organisations allowed to manufacture this ingredient for this product Users must be clear on the application of context relevant to their use case.Ingredient.manufacturer(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The way in which this manufacturer is associated with the ingredient. For example whether it is a possible one (others allowed), or an exclusive authorized one for this ingredient. Note that this is not the manufacturing process role. Binding: ingredient-manufacturer-role (required, The way in which this manufacturer is associated with the ingredient.); (xsd)role:code>?
< An organization that manufactures this ingredient.; (xsd)manufacturer:Organization*>🔗 The substance that comprises this ingredient.Ingredient.substance(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A code or full resource that represents the ingredient's substance. Binding: substance-codes (example, This value set includes all substance codes from SNOMED CT - provided as an exemplar value set.); (xsd)code:SubstanceDefinition*>
[]< The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item. The allowed repetitions do not represent different strengths, but are different representations - mathematically equivalent - of a single strength.; (xsd)strength:Ingredient.substance.strength>*🔗 The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item. The allowed repetitions do not represent different strengths, but are different representations - mathematically equivalent - of a single strength.Ingredient.substance.strength(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item. Unit of presentation refers to the quantity that the item occurs in e.g. a strength per tablet size, perhaps 'per 20mg' (the size of the tablet). It is not generally normalized as a unitary unit, which would be 'per mg').; (xsd)presentation:(<CodeableConcept>
|<Quantity>
|<Ratio>
|<RatioRange>)>?
< A textual represention of either the whole of the presentation strength or a part of it - with the rest being in Strength.presentation as a ratio.; (xsd)textPresentation:string>?
< The strength per unitary volume (or mass).; (xsd)concentration:(<CodeableConcept>
|<Quantity>
|<Ratio>
|<RatioRange>)>?
< A textual represention of either the whole of the concentration strength or a part of it - with the rest being in Strength.concentration as a ratio.; (xsd)textConcentration:string>?
< A code that indicates if the strength is, for example, based on the ingredient substance as stated or on the substance base (when the ingredient is a salt).; (xsd)basis:CodeableConcept>?
< For when strength is measured at a particular point or distance. There are products where strength is measured at a particular point. For example, the strength of the ingredient in some inhalers is measured at a particular position relative to the point of aerosolization.; (xsd)measurementPoint:string>?
[]< The country or countries for which the strength range applies. Binding: country (example, Jurisdiction codes); (xsd)country:CodeableConcept>*
[]< Strength expressed in terms of a reference substance. For when the ingredient strength is additionally expressed as equivalent to the strength of some other closely related substance (e.g. salt vs. base). Reference strength represents the strength (quantitative composition) of the active moiety of the active substance. There are situations when the active substance and active moiety are different, therefore both a strength and a reference strength are needed.; (xsd)referenceStrength:Ingredient.substance.strength.referenceStrength>*🔗 Strength expressed in terms of a reference substance. For when the ingredient strength is additionally expressed as equivalent to the strength of some other closely related substance (e.g. salt vs. base). Reference strength represents the strength (quantitative composition) of the active moiety of the active substance. There are situations when the active substance and active moiety are different, therefore both a strength and a reference strength are needed.Ingredient.substance.strength.referenceStrength(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Relevant reference substance. Binding: substance-codes (example, This value set includes all substance codes from SNOMED CT - provided as an exemplar value set.); (xsd)substance:SubstanceDefinition*>
< Strength expressed in terms of a reference substance.; (xsd)strength:(<Quantity>
|<Ratio>
|<RatioRange>)>
< For when strength is measured at a particular point or distance.; (xsd)measurementPoint:string>?
[]< The country or countries for which the strength range applies. Binding: country (example, Jurisdiction codes); (xsd)country:CodeableConcept>*🔗 Set of definitional characteristics for a kind of observation or measurement produced or consumed by an orderable health care service. An instance of this resource informs the consumer of a health-related service (such as a lab diagnostic test or panel) about how the observations used or produced by this service will look like.InputObservationDefinition(xsd)(doc)=
<#base:ObservationDefinition>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< An absolute URL that is used to identify this ObservationDefinition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this ObservationDefinition is (or will be) published. The URL SHOULD include the major version of the ObservationDefinition. For more information see Technical and Business Versions. Can be a urn:uuid: or a urn:oid:, but real http: addresses are preferred. This is the URI that will be used when making canonical references to this resource.; (xsd)url:uri>?
< Business identifiers assigned to this ObservationDefinition. by the performer and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server. This is a business identifier, not a resource identifier. It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types.; (xsd)identifier:Identifier>?
< The identifier that is used to identify this version of the ObservationDefinition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the ObservationDefinition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions are orderable. There may be multiple different instances of an observationDefinition that have the same identifier but different versions.; (xsd)version:string>?
< Indicates the mechanism used to compare versions to determine which is more current. If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined. Binding: version-algorithm (extensible, ); (xsd)versionAlgorithm:(<Coding>
|<string>)>?
< A natural language name identifying the ObservationDefinition. This name should be usable as an identifier for the module by machine processing applications such as code generation. The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.; (xsd)name:string>?
< A short, descriptive, user-friendly title for the ObservationDefinition.; (xsd)title:string>?
< The current state of the ObservationDefinition. A nominal state-transition diagram can be found in the [Definition pattern](http://hl7.org/fhir/R5/definition.html#statemachine) documentation
Unknown does not represent "other" - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is.
See guidance around (not) making local changes to elements [here](http://hl7.org/fhir/R5/canonicalresource.html#localization). Binding: publication-status (required, Codes identifying the state of an ObservationDefinition.); (xsd)status:code>
< A flag to indicate that this ObservationDefinition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage. Allows filtering of ObservationDefinition that are appropriate for use vs. not.; (xsd)experimental:boolean>?
< The date (and optionally time) when the ObservationDefinition was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the ObservationDefinition changes. The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the ObservationDefinition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
See guidance around (not) making local changes to elements [here](http://hl7.org/fhir/R5/canonicalresource.html#localization).; (xsd)date:dateTime>?
< Helps establish the "authority/credibility" of the ObservationDefinition. May also allow for contact.; (xsd)publisher:string>?
[]< Contact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc.
See guidance around (not) making local changes to elements [here](http://hl7.org/fhir/R5/canonicalresource.html#localization).; (xsd)contact:ContactDetail>*
< A free text natural language description of the ObservationDefinition from the consumer's perspective. This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the module as conveyed in the text field of the resource itself. This item SHOULD be populated unless the information is available from context.; (xsd)description:markdown>?
[]< The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate ObservationDefinition instances. When multiple usageContexts are specified, there is no expectation for whether all or any of the contexts apply.; (xsd)useContext:UsageContext>*
[]< A jurisdiction in which the ObservationDefinition is intended to be used. It may be possible for the ObservationDefinition to be used in jurisdictions other than those for which it was originally designed or intended.
DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.) Binding: jurisdiction (extensible, Codes for country, country subdivision and region for indicating where a resource is intended to be used.); (xsd)jurisdiction:CodeableConcept>*
< Explains why this ObservationDefinition is needed and why it has been designed as it has. This element does not describe the usage of the ObservationDefinition. Rather it is for traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this ObservationDefinition.; (xsd)purpose:markdown>?
< Copyright statement relating to the ObservationDefinition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the ObservationDefinition.; (xsd)copyright:markdown>?
< A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved'). The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.; (xsd)copyrightLabel:string>?
< The date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usage. The date may be more recent than the approval date because of minor changes / editorial corrections.
See guidance around (not) making local changes to elements [here](http://hl7.org/fhir/R5/canonicalresource.html#localization).; (xsd)approvalDate:date>?
< The date on which the asset content was last reviewed. Review happens periodically after that, but doesn't change the original approval date. If specified, this is usually after the approval date.
See guidance around (not) making local changes to elements [here](http://hl7.org/fhir/R5/canonicalresource.html#localization).; (xsd)lastReviewDate:date>?
< The period during which the ObservationDefinition content was or is planned to be effective. The effective period for an ObservationDefinition determines when the content is applicable for usage and is independent of publication and review dates. For example, an observation definition intended to be used for the year 2021 might be published in 2020.
See guidance around (not) making local changes to elements [here](http://hl7.org/fhir/R5/canonicalresource.html#localization).; (xsd)effectivePeriod:Period>?
[]< The canonical URL pointing to another FHIR-defined ObservationDefinition that is adhered to in whole or in part by this definition.; (xsd)derivedFromCanonical:ObservationDefinition*>*
[]< The URL pointing to an externally-defined observation definition, guideline or other definition that is adhered to in whole or in part by this definition.; (xsd)derivedFromUri:uri>*
[]< A code that describes the intended kind of subject of Observation instances conforming to this ObservationDefinition. Examples: person, animal, device, air, surface ….; (xsd)subject:CodeableConcept>*
< The type of individual/organization/device that is expected to act upon instances of this definition.; (xsd)performerType:CodeableConcept>?
[]< A code that classifies the general type of observation. This element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used for one instance of ObservationDefinition. The level of granularity is defined by the category concepts in the value set. Binding: observation-category (example, Codes for high level observation categories.); (xsd)category:CodeableConcept>*
< Describes what will be observed. Sometimes this is called the observation "name". Binding: observation-codes (example, Codes identifying names of simple observations.); (xsd)code:InputObservationDefinition.code>
[]< The data types allowed for the value element of the instance observations conforming to this ObservationDefinition. Binding: permitted-data-type (required, Permitted data type for observation value.); (xsd)permittedDataType:code>*
< Multiple results allowed for observations conforming to this ObservationDefinition. An example of observation allowing multiple results is "bacteria identified by culture". Conversely, the measurement of a potassium level allows a single result.; (xsd)multipleResultsAllowed:boolean>?
< The site on the subject's body where the observation is to be made. Only used if the defined observation is to be made directly on a body part and if this body part is not implied by code found in ObservationDefinition.code. Not used for in vitro diagnostic observations.
Example: 14975008 |Forearm structure|. Binding: body-site (example, SNOMED CT body structures.); (xsd)bodySite:CodeableConcept>?
< The method or technique used to perform the observation. Only used if not implicit in observation code
Example: 702659008 |Automated count technique|. Binding: observation-methods (example, Methods for simple observations.); (xsd)method:CodeableConcept>?
[]< The kind of specimen that this type of observation is produced on. Only used for in vitro observations. When multiple occurrences of specimen are present, they are to be combined with a logical AND: all specified specimens are needed for the observation.; (xsd)specimen:SpecimenDefinition*>*
[]< The measurement model of device or actual device used to produce observations of this type. When multiple occurrences of device are present, they are to be combined with a logical OR: at least one of the specified devices is used to produce the observation.; (xsd)device:(<Device>
|<DeviceDefinition>)>*
< The preferred name to be used when reporting the results of observations conforming to this ObservationDefinition.; (xsd)preferredReportName:string>?
[]< Units allowed for the valueQuantity element in the instance observations conforming to this ObservationDefinition. Binding: ucum-units (preferred, Codes identifying units of measure.); (xsd)permittedUnit:Coding>*
[]< A set of qualified values associated with a context and a set of conditions - provides a range for quantitative and ordinal observations and a collection of value sets for qualitative observations.; (xsd)qualifiedValue:InputObservationDefinition.qualifiedValue>*
[]< This ObservationDefinition defines a group observation (e.g. a battery, a panel of tests, a set of vital sign measurements) that includes the target as a member of the group.; (xsd)hasMember:(<ObservationDefinition>
|<Questionnaire>)>*
[]< Some observations have multiple component observations, expressed as separate code value pairs.; (xsd)component:InputObservationDefinition.component>*🔗 Describes what will be observed. Sometimes this is called the observation "name". Binding: observation-codes (example, Codes identifying names of simple observations.)InputObservationDefinition.code(xsd)(doc)=
<#base:CodeableConcept>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< 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.; (xsd)coding:Coding>*
< 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.; (xsd)text:string>?
[]< 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.; (xsd)LOINC:InputObservationDefinition.code.LOINC>*🔗 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.InputObservationDefinition.code.LOINC(xsd)(doc)=
<#base:Coding>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< 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 be an absolute reference to some definition that establishes the system clearly and unambiguously. http://loinc.org; (xsd)system:uri>?
< 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.; (xsd)version:string>?
< 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).; (xsd)code>?
< A representation of the meaning of the code in the system, following the rules of the system.; (xsd)display:string>?
< 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.; (xsd)userSelected:boolean>?🔗 Some observations have multiple component observations, expressed as separate code value pairs.InputObservationDefinition.component(xsd)(doc)=
<#base:ObservationDefinition.component>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Describes what will be observed. Binding: observation-codes (example, Codes identifying names of simple observations.); (xsd)code:CodeableConcept>
[]< The data types allowed for the value element of the instance of this component observations. Binding: permitted-data-type (required, Permitted data type for observation value.); (xsd)permittedDataType:code>*
[]< Units allowed for the valueQuantity element in the instance observations conforming to this ObservationDefinition. Binding: ucum-units (preferred, Codes identifying units of measure.); (xsd)permittedUnit:Coding>*
[]< A set of qualified values associated with a context and a set of conditions - provides a range for quantitative and ordinal observations and a collection of value sets for qualitative observations.; (xsd)qualifiedValue:ObservationDefinition.qualifiedValue>*🔗 A set of qualified values associated with a context and a set of conditions - provides a range for quantitative and ordinal observations and a collection of value sets for qualitative observations.InputObservationDefinition.qualifiedValue(xsd)(doc)=
<#base:ObservationDefinition.qualifiedValue>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A concept defining the context for this set of qualified values. Binding: referencerange-meaning (extensible, ); (xsd)context:CodeableConcept>?
[]< The target population this set of qualified values applies to. If this element is not present then the global population is assumed. Binding: referencerange-appliesto (example, ); (xsd)appliesTo:CodeableConcept>*
< The gender this set of qualified values applies to. Binding: administrative-gender (required, ); (xsd)gender:code>?
< The age range this set of qualified values applies to. Some analytes vary greatly over age.; (xsd)age:Range>?
< The gestational age this set of qualified values applies to.; (xsd)gestationalAge:Range>?
< Text based condition for which the the set of qualified values is valid.; (xsd)condition:string>?
< The category of range of values for continuous or ordinal observations that match the criteria of this set of qualified values. Binding: observation-range-category (required, ); (xsd)rangeCategory:code>?
< The range of values defined for continuous or ordinal observations that match the criteria of this set of qualified values.; (xsd)range:Range>?
< The set of valid coded results for qualitative observations that match the criteria of this set of qualified values.; (xsd)validCodedValueSet:ValueSet*>?
< The set of normal coded results for qualitative observations that match the criteria of this set of qualified values.; (xsd)normalCodedValueSet:ValueSet*>?
< The set of abnormal coded results for qualitative observations that match the criteria of this set of qualified values.; (xsd)abnormalCodedValueSet:ValueSet*>?
< The set of critical coded results for qualitative observations that match the criteria of this set of qualified values.; (xsd)criticalCodedValueSet:ValueSet*>?🔗 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. UTC offset is always requiredinstant(xsd)(doc)=
<#base:PrimitiveType>
< unique id for the element within a resource (for internal references); (xsd)id:string>?
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< The actual value; (xsd)value:dateTime>?🔗 Details of a Health Insurance product/plan provided by an organization.InsurancePlan(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< Business identifiers assigned to this health insurance product which remain constant as the resource is updated and propagates from server to server.; (xsd)identifier:Identifier>*
< The current state of the health insurance product. Binding: publication-status (required, The lifecycle status of an artifact.); (xsd)status:code>?
[]< The kind of health insurance product. Binding: insuranceplan-type (example, Used to categorize the product/plan.); (xsd)type:CodeableConcept>*
< Official name of the health insurance product as designated by the owner. If the name of the product/plan changes, consider putting the old name in the alias column so that it can still be located through searches.; (xsd)name:string>?
[]< A list of alternate names that the product is known as, or was known as in the past. There are no dates associated with the alias/historic names, as this is not intended to track when names were used, but to assist in searching so that older names can still result in identifying the product/plan.; (xsd)alias:string>*
< The period of time that the health insurance product is available.; (xsd)period:Period>?
< The entity that is providing the health insurance product and underwriting the risk. This is typically an insurance carriers, other third-party payers, or health plan sponsors comonly referred to as 'payers'.; (xsd)ownedBy:Organization*>?
< An organization which administer other services such as underwriting, customer service and/or claims processing on behalf of the health insurance product owner.; (xsd)administeredBy:Organization*>?
[]< The geographic region in which a health insurance product's benefits apply.; (xsd)coverageArea:Location*>*
[]< The contact details of communication devices available relevant to the specific Insurance Plan/Product. This can include addresses, phone numbers, fax numbers, mobile numbers, email addresses and web sites. The address/telecom use code 'home' are not to be used.; (xsd)contact:ExtendedContactDetail>*
[]< The technical endpoints providing access to services operated for the health insurance product.; (xsd)endpoint:Endpoint*>*
[]< Reference to the network included in the health insurance product. Networks are represented as a hierarchy of organization resources.; (xsd)network:Organization*>*
[]< Details about the coverage offered by the insurance product.; (xsd)coverage:InsurancePlan.coverage>*
[]< Details about an insurance plan.; (xsd)plan:InsurancePlan.plan>*🔗 Details about the coverage offered by the insurance product.InsurancePlan.coverage(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Type of coverage (Medical; Dental; Mental Health; Substance Abuse; Vision; Drug; Short Term; Long Term Care; Hospice; Home Health).; (xsd)type:CodeableConcept>
[]< Reference to the network that providing the type of coverage. Networks are represented as a hierarchy of organization resources.; (xsd)network:Organization*>*
[]< Specific benefits under this type of coverage.; (xsd)benefit:InsurancePlan.coverage.benefit>+🔗 Specific benefits under this type of coverage.InsurancePlan.coverage.benefit(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Type of benefit (primary care; speciality care; inpatient; outpatient).; (xsd)type:CodeableConcept>
< The referral requirements to have access/coverage for this benefit.; (xsd)requirement:string>?
[]< The specific limits on the benefit.; (xsd)limit:InsurancePlan.coverage.benefit.limit>*🔗 The specific limits on the benefit.InsurancePlan.coverage.benefit.limit(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The maximum amount of a service item a plan will pay for a covered benefit. For examples. wellness visits, or eyeglasses. May also be called “eligible expense,” “payment allowance,” or “negotiated rate.”.; (xsd)value:Quantity>?
< The specific limit on the benefit. Use `CodeableConcept.text` element if the data is free (uncoded) text.; (xsd)code:CodeableConcept>?🔗 Details about an insurance plan.InsurancePlan.plan(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< Business identifiers assigned to this health insurance plan which remain constant as the resource is updated and propagates from server to server.; (xsd)identifier:Identifier>*
< Type of plan. For example, "Platinum" or "High Deductable".; (xsd)type:CodeableConcept>?
[]< The geographic region in which a health insurance plan's benefits apply.; (xsd)coverageArea:Location*>*
[]< Reference to the network that providing the type of coverage. Networks are represented as a hierarchy of organization resources.; (xsd)network:Organization*>*
[]< Overall costs associated with the plan.; (xsd)generalCost:InsurancePlan.plan.generalCost>*
[]< Costs associated with the coverage provided by the product.; (xsd)specificCost:InsurancePlan.plan.specificCost>*🔗 Overall costs associated with the plan.InsurancePlan.plan.generalCost(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Type of cost.; (xsd)type:CodeableConcept>?
< Number of participants enrolled in the plan.; (xsd)groupSize:positiveInt>?
< Value of the cost.; (xsd)cost:Money>?
< Additional information about the general costs associated with this plan.; (xsd)comment:string>?🔗 Costs associated with the coverage provided by the product.InsurancePlan.plan.specificCost(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< General category of benefit (Medical; Dental; Vision; Drug; Mental Health; Substance Abuse; Hospice, Home Health).; (xsd)category:CodeableConcept>
[]< List of the specific benefits under this category of benefit.; (xsd)benefit:InsurancePlan.plan.specificCost.benefit>*🔗 List of the specific benefits under this category of benefit.InsurancePlan.plan.specificCost.benefit(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Type of specific benefit (preventative; primary care office visit; speciality office visit; hospitalization; emergency room; urgent care).; (xsd)type:CodeableConcept>
[]< List of the costs associated with a specific benefit.; (xsd)cost:InsurancePlan.plan.specificCost.benefit.cost>*🔗 List of the costs associated with a specific benefit.InsurancePlan.plan.specificCost.benefit.cost(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Type of cost (copay; individual cap; family cap; coinsurance; deductible).; (xsd)type:CodeableConcept>
< Whether the cost applies to in-network or out-of-network providers (in-network; out-of-network; other). Binding: insuranceplan-applicability (required, Whether the cost applies to in-network or out-of-network providers.); (xsd)applicability:CodeableConcept>?
[]< Additional information about the cost, such as information about funding sources (e.g. HSA, HRA, FSA, RRA).; (xsd)qualifiers:CodeableConcept>*
< The actual cost value. (some of the costs may be represented as percentages rather than currency, e.g. 10% coinsurance).; (xsd)value:Quantity>?🔗 A whole number 32 bit number; for values larger than this, use decimalinteger(xsd)(doc)=
<#base:PrimitiveType>
< unique id for the element within a resource (for internal references); (xsd)id:string>?
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< The actual value; (xsd)value:integer>?🔗 A very large whole number Typically this is used for record counters (e.g. database keys)integer64(xsd)(doc)=
<#base:PrimitiveType>
< unique id for the element within a resource (for internal references); (xsd)id:string>?
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< The actual value; (xsd)value:integer>?🔗 A single issue - either an indication, contraindication, interaction or an undesirable effect for a medicinal product, medication, device or procedure.InteractionDefinition(xsd)(doc)=
<#base:ClinicalUseDefinition>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< Business identifier for this issue.; (xsd)identifier:Identifier>*
< indication | contraindication | interaction | undesirable-effect | warning. Binding: clinical-use-definition-type (required, Overall defining type of this clinical use definition.) interaction; (xsd)type:code>
[]< A categorisation of the issue, primarily for dividing warnings into subject heading areas such as "Pregnancy and Lactation", "Overdose", "Effects on Ability to Drive and Use Machines". Binding: clinical-use-definition-category (preferred, A categorisation for a clinical use information item.); (xsd)category:CodeableConcept>*
[]< The medication, product, substance, device, procedure etc. for which this is an indication.; (xsd)subject:(<ActivityDefinition>
|<BiologicallyDerivedProduct>
|<Device>
|<DeviceDefinition>
|<Medication>
|<MedicinalProductDefinition>
|<NutritionProduct>
|<PlanDefinition>
|<Substance>)>*
< Whether this is a current issue or one that has been retired etc. Binding: publication-status (preferred, The lifecycle status of an artifact.); (xsd)status:CodeableConcept>?
< Specifics for when this is a contraindication.; (xsd)contraindication:InteractionDefinition.contraindication>{0,0}
< Specifics for when this is an indication.; (xsd)indication:InteractionDefinition.indication>{0,0}
< Specifics for when this is an interaction.; (xsd)interaction:InteractionDefinition.interaction>
[]< The population group to which this applies.; (xsd)population:Group*>*
[]< Logic used by the clinical use definition.; (xsd)library:Library*>*
< Describe the possible undesirable effects (negative outcomes) from the use of the medicinal product as treatment.; (xsd)undesirableEffect:InteractionDefinition.undesirableEffect>{0,0}
< A critical piece of information about environmental, health or physical risks or hazards that serve as caution to the user. For example 'Do not operate heavy machinery', 'May cause drowsiness', or 'Get medical advice/attention if you feel unwell'.; (xsd)warning:InteractionDefinition.warning>{0,0}🔗 Specifics for when this is a contraindication.InteractionDefinition.contraindication(xsd)(doc)=
<#base:ClinicalUseDefinition.contraindication>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The situation that is being documented as contraindicating against this item. Binding: disease-symptom-procedure (example, A symptom, disease or procedure.); (xsd)diseaseSymptomProcedure:ObservationDefinition*>?
< The status of the disease or symptom for the contraindication, for example "chronic" or "metastatic". Binding: disease-status (example, The status of a disease or symptom.); (xsd)diseaseStatus:ObservationDefinition*>?
[]< A comorbidity (concurrent condition) or coinfection. Binding: disease-symptom-procedure (example, A symptom, disease or procedure.); (xsd)comorbidity:ObservationDefinition*>*
[]< The indication which this is a contraidication for.; (xsd)indication:ClinicalUseDefinition*>*
< An expression that returns true or false, indicating whether the indication is applicable or not, after having applied its other elements. The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.; (xsd)applicability:Expression>?
[]< Information about the use of the medicinal product in relation to other therapies described as part of the contraindication.; (xsd)otherTherapy:InteractionDefinition.contraindication.otherTherapy>*🔗 Information about the use of the medicinal product in relation to other therapies described as part of the contraindication.InteractionDefinition.contraindication.otherTherapy(xsd)(doc)=
<#base:ClinicalUseDefinition.contraindication.otherTherapy>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The type of relationship between the medicinal product indication or contraindication and another therapy. Binding: therapy-relationship-type (preferred, Classification of relationship between a therapy and a contraindication or an indication.); (xsd)relationshipType:CodeableConcept>
< Reference to a specific medication (active substance, medicinal product or class of products, biological, food etc.) as part of an indication or contraindication. Binding: therapy (example, A therapy.); (xsd)treatment:(<ActivityDefinition>
|<BiologicallyDerivedProduct>
|<Medication>
|<MedicinalProductDefinition>
|<NutritionProduct>
|<Substance>
|<SubstanceDefinition>)>🔗 Specifics for when this is an indication.InteractionDefinition.indication(xsd)(doc)=
<#base:ClinicalUseDefinition.indication>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The situation that is being documented as an indicaton for this item. Binding: disease-symptom-procedure (example, A symptom, disease or procedure.); (xsd)diseaseSymptomProcedure:ObservationDefinition*>?
< The status of the disease or symptom for the indication, for example "chronic" or "metastatic". Binding: disease-status (example, The status of a disease or symptom.); (xsd)diseaseStatus:ObservationDefinition*>?
[]< A comorbidity (concurrent condition) or coinfection as part of the indication. Binding: disease-symptom-procedure (example, A symptom, disease or procedure.); (xsd)comorbidity:ObservationDefinition*>*
< The intended effect, aim or strategy to be achieved. Binding: product-intended-use (preferred, The overall intended use of a product.); (xsd)intendedEffect:ObservationDefinition*>?
< Timing or duration information, that may be associated with use with the indicated condition e.g. Adult patients suffering from myocardial infarction (from a few days until less than 35 days), ischaemic stroke (from 7 days until less than 6 months).; (xsd)duration:(<Range>
|<string>)>?
[]< An unwanted side effect or negative outcome that may happen if you use the drug (or other subject of this resource) for this indication.; (xsd)undesirableEffect:ClinicalUseDefinition*>*
< An expression that returns true or false, indicating whether the indication is applicable or not, after having applied its other elements. The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.; (xsd)applicability:Expression>?
[]< Information about the use of the medicinal product in relation to other therapies described as part of the indication.; (xsd)otherTherapy:ClinicalUseDefinition.contraindication.otherTherapy>*🔗 Specifics for when this is an interaction.InteractionDefinition.interaction(xsd)(doc)=
<#base:ClinicalUseDefinition.interaction>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< The specific medication, product, food, substance etc. or laboratory test that interacts.; (xsd)interactant:InteractionDefinition.interaction.interactant>*
< The type of the interaction e.g. drug-drug interaction, drug-food interaction, drug-lab test interaction. Binding: interaction-type (example, A categorisation for an interaction between two substances.); (xsd)type:CodeableConcept>?
< The effect of the interaction, for example "reduced gastric absorption of primary medication". Binding: interaction-effect (example, A interaction effect of clinical use of a medication or other substance.); (xsd)effect:ObservationDefinition*>?
< The incidence of the interaction, e.g. theoretical, observed. Binding: interaction-incidence (example, A categorisation for incidence of occurence of an interaction.); (xsd)incidence:CodeableConcept>?
[]< Actions for managing the interaction. Binding: interaction-management (example, A type of management for an interaction of a medication or other substance.); (xsd)management:CodeableConcept>*🔗 The specific medication, product, food, substance etc. or laboratory test that interacts.InteractionDefinition.interaction.interactant(xsd)(doc)=
<#base:ClinicalUseDefinition.interaction.interactant>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The specific medication, product, food, substance etc. or laboratory test that interacts. Binding: interactant (example, An interactant - a substance that may have a clinically significant effect on another.); (xsd)item:(<BiologicallyDerivedProduct>
|<CodeableConcept>
|<Medication>
|<MedicinalProductDefinition>
|<NutritionProduct>
|<ObservationDefinition>
|<Substance>)>🔗 Describe the possible undesirable effects (negative outcomes) from the use of the medicinal product as treatment.InteractionDefinition.undesirableEffect(xsd)(doc)=
<#base:ClinicalUseDefinition.undesirableEffect>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The situation in which the undesirable effect may manifest. Binding: undesirable-effect-symptom (example, An undesirable effect of clinical use.); (xsd)symptomConditionEffect:ObservationDefinition*>?
< High level classification of the effect. Binding: undesirable-effect-classification (example, A categorisation for an undesirable effect.); (xsd)classification:CodeableConcept>?
< How often the effect is seen. Binding: undesirable-effect-frequency (example, A categorisation for a frequency of occurence of an undesirable effect.); (xsd)frequencyOfOccurrence:CodeableConcept>?🔗 A critical piece of information about environmental, health or physical risks or hazards that serve as caution to the user. For example 'Do not operate heavy machinery', 'May cause drowsiness', or 'Get medical advice/attention if you feel unwell'.InteractionDefinition.warning(xsd)(doc)=
<#base:ClinicalUseDefinition.warning>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A textual definition of this warning, with formatting.; (xsd)description:markdown>?
< A coded or unformatted textual definition of this warning. Binding: warning-type (example, Classification of warning type.); (xsd)code:CodeableConcept>?🔗 A functional description of an inventory item used in inventory and supply-related workflows.InventoryItem(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< Business identifier for the inventory item.; (xsd)identifier:Identifier>*
< Status of the item entry. Binding: inventoryitem-status (required, Status of the inventory item.); (xsd)status:code>
[]< Category or class of the item.; (xsd)category:CodeableConcept>*
[]< Code designating the specific type of item.; (xsd)code:CodeableConcept>*
[]< The item name(s) - the brand name, or common name, functional name, generic name.; (xsd)name:InventoryItem.name>*
[]< Organization(s) responsible for the product.; (xsd)responsibleOrganization:InventoryItem.responsibleOrganization>*
< The descriptive characteristics of the inventory item.; (xsd)description:InventoryItem.description>?
[]< The usage status e.g. recalled, in use, discarded... This can be used to indicate that the items have been taken out of inventory, or are in use, etc.; (xsd)inventoryStatus:CodeableConcept>*
< The base unit of measure - the unit in which the product is used or counted.; (xsd)baseUnit:CodeableConcept>?
< Net content or amount present in the item.; (xsd)netContent:SimpleQuantity>?
[]< Association with other items or products.; (xsd)association:InventoryItem.association>*
[]< The descriptive or identifying characteristics of the item.; (xsd)characteristic:InventoryItem.characteristic>*
< Instances or occurrences of the product.; (xsd)instance:InventoryItem.instance>?
< Link to a product resource used in clinical workflows.; (xsd)productReference:(<BiologicallyDerivedProduct>
|<Device>
|<Medication>
|<NutritionProduct>)>?🔗 Association with other items or products.InventoryItem.association(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< This attribute defined the type of association when establishing associations or relations between items, e.g. 'packaged within' or 'used with' or 'to be mixed with.; (xsd)associationType:CodeableConcept>
< The related item or product.; (xsd)relatedItem:(<BiologicallyDerivedProduct>
|<Device>
|<DeviceDefinition>
|<InventoryItem>
|<Medication>
|<MedicationKnowledge>
|<NutritionProduct>)>
< The quantity of the related product in this product - Numerator is the quantity of the related product. Denominator is the quantity of the present product. For example a value of 20 means that this product contains 20 units of the related product; a value of 1:20 means the inverse - that the contained product contains 20 units of the present product.; (xsd)quantity:Ratio>🔗 The descriptive characteristics of the inventory item.InventoryItem.description(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The language for the item description, when an item must be described in different languages and those languages may be authoritative and not translations of a 'main' language. Binding: languages (required, Description languages.); (xsd)language:code>?
< Textual description of the item.; (xsd)description:string>?🔗 The descriptive or identifying characteristics of the item.InventoryItem.characteristic(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The type of characteristic that is being defined.; (xsd)characteristicType:CodeableConcept>
(<valueAddress:Address>
|<valueAnnotation:Annotation>
|<valueBoolean:boolean>
|<valueCodeableConcept:CodeableConcept>
|<valueDateTime:dateTime>
|<valueDecimal:decimal>
|<valueDuration:Duration>
|<valueInteger:integer>
|<valueQuantity:Quantity>
|<valueRange:Range>
|<valueRatio:Ratio>
|<valueString:string>
|<valueUrl:url>)🔗 Instances or occurrences of the product.InventoryItem.instance(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< The identifier for the physical instance, typically a serial number.; (xsd)identifier:Identifier>*
< The lot or batch number of the item.; (xsd)lotNumber:string>?
< The expiry date or date and time for the product.; (xsd)expiry:dateTime>?
< The subject that the item is associated with.; (xsd)subject:(<Organization>
|<Patient>)>?
< The location that the item is associated with.; (xsd)location:Location*>?🔗 The item name(s) - the brand name, or common name, functional name, generic name.InventoryItem.name(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The type of name e.g. 'brand-name', 'functional-name', 'common-name'. Binding: inventoryitem-nametype (preferred, Name types.); (xsd)nameType:Coding>
< The language that the item name is expressed in. Binding: languages (required, Name languages.); (xsd)language:code>
< The name or designation that the item is given.; (xsd)name:string>🔗 Organization(s) responsible for the product.InventoryItem.responsibleOrganization(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The role of the organization e.g. manufacturer, distributor, etc.; (xsd)role:CodeableConcept>
< An organization that has an association with the item, e.g. manufacturer, distributor, responsible, etc.; (xsd)organization:Organization*>🔗 A report of inventory or stock items.InventoryReport(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< Business identifier for the InventoryReport.; (xsd)identifier:Identifier>*
< The status of the inventory check or notification - whether this is draft (e.g. the report is still pending some updates) or active. Binding: inventoryreport-status (required, The status of the InventoryReport.); (xsd)status:code>
< Whether the report is about the current inventory count (snapshot) or a differential change in inventory (change). Binding: inventoryreport-counttype (required, The type of count.); (xsd)countType:code>
< What type of operation is being performed - addition or subtraction.; (xsd)operationType:CodeableConcept>?
< The reason for this count - regular count, ad-hoc count, new arrivals, etc.; (xsd)operationTypeReason:CodeableConcept>?
< When the report has been submitted.; (xsd)reportedDateTime:dateTime>
< Who submits the report.; (xsd)reporter:(<Device>
|<Patient>
|<Practitioner>
|<RelatedPerson>)>?
< The period the report refers to.; (xsd)reportingPeriod:Period>?
[]< An inventory listing section (grouped by any of the attributes).; (xsd)inventoryListing:InventoryReport.inventoryListing>*
[]< A note associated with the InventoryReport.; (xsd)note:Annotation>*🔗 An inventory listing section (grouped by any of the attributes).InventoryReport.inventoryListing(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Location of the inventory items.; (xsd)location:Location*>?
< The status of the items.; (xsd)itemStatus:CodeableConcept>?
< The date and time when the items were counted.; (xsd)countingDateTime:dateTime>?
[]< The item or items in this listing.; (xsd)item:InventoryReport.inventoryListing.item>*🔗 The item or items in this listing.InventoryReport.inventoryListing.item(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The inventory category or classification of the items being reported. This is meant not for defining the product, but for inventory categories e.g. 'pending recount' or 'damaged'.; (xsd)category:CodeableConcept>?
< The quantity of the item or items being reported.; (xsd)quantity:Quantity>
< The code or reference to the item type.; (xsd)item:(<BiologicallyDerivedProduct>
|<Device>
|<InventoryItem>
|<Medication>
|<NutritionProduct>)>🔗 Invoice containing collected ChargeItems from an Account with calculated individual and total price for Billing purpose.Invoice(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< Identifier of this Invoice, often used for reference in correspondence about this invoice or for tracking of payments.; (xsd)identifier:Identifier>*
< The current state of the Invoice. Binding: invoice-status (required, Codes identifying the lifecycle stage of an Invoice.); (xsd)status:code>
< In case of Invoice cancellation a reason must be given (entered in error, superseded by corrected invoice etc.). Derived Profiles may choose to add invariants requiring this field to be populated if either priceOverride or factorOverride have been filled.; (xsd)cancelledReason:string>?
< Type of Invoice depending on domain, realm an usage (e.g. internal/external, dental, preliminary).; (xsd)type:CodeableConcept>?
< The individual or set of individuals receiving the goods and services billed in this invoice.; (xsd)subject:(<Group>
|<Patient>)>?
< The individual or Organization responsible for balancing of this invoice.; (xsd)recipient:(<Organization>
|<Patient>
|<RelatedPerson>)>?
< Depricared by the element below.; (xsd)date:dateTime>?
< Date/time(s) of when this Invoice was posted. The list of types may be constrained as appropriate for the type of charge item.; (xsd)creation:dateTime>?
< Date/time(s) range of services included in this invoice.; (xsd)period:(<date>
|<Period>)>?
[]< Indicates who or what performed or participated in the charged service.; (xsd)participant:Invoice.participant>*
< The organizationissuing the Invoice. Practitioners and Devices can be associated with multiple organizations. It has to be made clear, on behalf of which Organization the services have been rendered.; (xsd)issuer:Organization*>?
< Account which is supposed to be balanced with this Invoice. Systems posting the ChargeItems might not always be able to determine, which accounts the Items need to be places into. It is up to the potprocessing Financial System to apply internal rules to decide based on the Encounter/EpisodeOfCare/Patient/Coverage context and the type of ChargeItem, which Account is appropriate.; (xsd)account:Account*>?
[]< Each line item represents one charge for goods and services rendered. Details such.ofType(date), code and amount are found in the referenced ChargeItem resource.; (xsd)lineItem:Invoice.lineItem>*
[]< The total amount for the Invoice may be calculated as the sum of the line items with surcharges/deductions that apply in certain conditions. The priceComponent element can be used to offer transparency to the recipient of the Invoice of how the total price was calculated.; (xsd)totalPriceComponent:MonetaryComponent>*
< Invoice total , taxes excluded. There is no reason to carry the price in the instance of a ChargeItem unless circumstances require a manual override. The list prices or are usually defined in a back catalogue of the billing codes (see ChargeItem.definition). Derived profiles may require a ChargeItem.overrideReason to be provided if either factor or price are manually overridden.; (xsd)totalNet:Money>?
< Invoice total, tax included. There is no reason to carry the price in the instance of a ChargeItem unless circumstances require a manual override. The list prices or are usually defined in a back catalogue of the billing codes (see ChargeItem.definition). Derived profiles may require a ChargeItem.overrideReason to be provided if either factor or price are manually overridden.; (xsd)totalGross:Money>?
< Payment details such as banking details, period of payment, deductibles, methods of payment. Derived Profiles may chose to add invariants requiring this field to be populated if either priceOverride or factorOverride have been filled.; (xsd)paymentTerms:markdown>?
[]< Comments made about the invoice by the issuer, subject, or other participants.; (xsd)note:Annotation>*🔗 Each line item represents one charge for goods and services rendered. Details such.ofType(date), code and amount are found in the referenced ChargeItem resource.Invoice.lineItem(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Sequence in which the items appear on the invoice.; (xsd)sequence:positiveInt>?
< Date/time(s) range when this service was delivered or completed.; (xsd)serviced:(<date>
|<Period>)>?
< The ChargeItem contains information such as the billing code, date, amount etc. If no further details are required for the lineItem, inline billing codes can be added using the CodeableConcept data type instead of the Reference.; (xsd)chargeItem:(<CodeableConcept>
|<ChargeItem>)>
[]< The price for a ChargeItem may be calculated as a base price with surcharges/deductions that apply in certain conditions. A ChargeItemDefinition resource that defines the prices, factors and conditions that apply to a billing code is currently under development. The priceComponent element can be used to offer transparency to the recipient of the Invoice as to how the prices have been calculated.; (xsd)priceComponent:MonetaryComponent>*🔗 Indicates who or what performed or participated in the charged service.Invoice.participant(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Describes the type of involvement (e.g. transcriptionist, creator etc.). If the invoice has been created automatically, the Participant may be a billing engine or another kind of device.; (xsd)role:CodeableConcept>?
< The device, practitioner, etc. who performed or participated in the service.; (xsd)actor:(<Device>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>🔗 A container for a collection of resources.ItemTransactionRequest(xsd)(doc)=
<#base:Bundle>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< A persistent identifier for the bundle that won't change as a bundle is copied from server to server. Persistent identity generally only matters for batches of type Document, Message, and Collection. It would not normally be populated for search and history results and servers ignore Bundle.identifier when processing batches and transactions. For Documents the .identifier SHALL be populated such that the .identifier is globally unique.; (xsd)identifier:Identifier>?
< This transaction Bundle is to convey the request to create/update/delete/patch content of a catalog, from the Catalog Owner to the Catalog Custodian This transaction Bundle is usable with any kind of catalog (laboratory compendium, drug formulary, order sets, devices ...) Binding: bundle-type (required, Indicates the purpose of a bundle - how it is intended to be used.) transaction; (xsd)type:code>
< The date/time that the bundle was assembled - i.e. when the resources were placed in the bundle. For many bundles, the timestamp is equal to .meta.lastUpdated, because they are not stored (e.g. search results). When a bundle is placed in a persistent store, .meta.lastUpdated will be usually be changed by the server. When the bundle is a message, a middleware agent altering the message (even if not stored) SHOULD update .meta.lastUpdated. .timestamp is used to track the original time of the Bundle, and SHOULD be populated.
Usage:
* document : the date the document was created. Note: the composition may predate the document, or be associated with multiple documents. The date of the composition - the authoring time - may be earlier than the document assembly time
* message : the date that the content of the message was assembled. This date is not changed by middleware engines unless they add additional data that changes the meaning of the time of the message
* history : the date that the history was assembled. This time would be used as the _since time to ask for subsequent updates
* searchset : the time that the search set was assembled. Note that different pages MAY have different timestamps but need not. Having different timestamps does not imply that subsequent pages will represent or include changes made since the initial query
* transaction | transaction-response | batch | batch-response | collection : no particular assigned meaning
The timestamp value should be greater than the lastUpdated and other timestamps in the resources in the bundle, and it should be equal or earlier than the .meta.lastUpdated on the Bundle itself.; (xsd)timestamp:instant>?
< If a set of search matches, this is the (potentially estimated) total number of entries of type 'match' across all pages in the search. It does not include search.mode = 'include' or 'outcome' entries and it does not provide a count of the number of entries in the Bundle. Only used if the bundle is a search result set. The total does not include resources such as OperationOutcome and included resources, only the total number of matching resources.; (xsd)total:unsignedInt>?
[]< A series of links that provide context to this bundle. Both Bundle.link and Bundle.entry.link are defined to support providing additional context when Bundles are used (e.g. [HATEOAS](http://en.wikipedia.org/wiki/HATEOAS)).
Bundle.entry.link corresponds to links found in the HTTP header if the resource in the entry was [read](http://hl7.org/fhir/R5/http.html#read) directly.
This specification defines some specific uses of Bundle.link for [searching](http://hl7.org/fhir/R5/search.html#conformance) and [paging](http://hl7.org/fhir/R5/http.html#paging), but no specific uses for Bundle.entry.link, and no defined function in a transaction - the meaning is implementation specific. The behavior of navigation link types (next/prev/first/last) are well defined for searchset and history Bundles but are not currently defined for other types. Implementers who choose to use such link relationships for other bundle types will need to negotiate behavior with their interoperability partners.; (xsd)link:ItemTransactionRequest.link>*
[]< Each entry will contain a resource representing a catalog item or one of the supporting resources of a catalog item.
The resource will be followed by a request instructing the Catalog Custodian what action (create/update/delete/patch) to perform on this resource; (xsd)entry:ItemTransactionRequest.entry>+
< Digital Signature - base64 encoded. XML-DSig or a JWS. The signature could be created by the "author" of the bundle or by the originating device. Requirements around inclusion of a signature, verification of signatures and treatment of signed/non-signed bundles is implementation-environment specific.; (xsd)signature:Signature>?
< Captures issues and warnings that relate to the construction of the Bundle and the content within it. Usage notes: These issues and warnings must apply to the Bundle as a whole, not to individual entries.Messages relating to the processing of individual entries (e.g. in a batch or transaction) SHALL be reported in the entry.response.outcome for that entry. If there are errors that arise in the creation of the Bundle, then that should be handled by an OperationOutcome being returned instead of the Bundle.; (xsd)issues:OperationOutcome>?🔗 Each entry will contain a resource representing a catalog item or one of the supporting resources of a catalog item.
The resource will be followed by a request instructing the Catalog Custodian what action (create/update/delete/patch) to perform on this resourceItemTransactionRequest.entry(xsd)(doc)=
<#base:Bundle.entry>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< A series of links that provide context to this entry.; (xsd)link:Bundle.link>*
< The Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when:
* invoking a create
* invoking or responding to an operation where the body is not a single identified resource
* invoking or returning the results of a search or history operation. fullUrl might not be [unique in the context of a resource](http://hl7.org/fhir/R5/bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](http://hl7.org/fhir/R5/references.html), the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the [regex](http://hl7.org/fhir/R5/references.html#regex), then the 'id' portion of the fullUrl SHALL end with the Resource.id.
Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).; (xsd)fullUrl:uri>
< The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. This is allowed to be a Parameters resource if and only if it is referenced by something else within the Bundle that provides context/meaning.; (xsd)resource:Resource>
< Information about the search process that lead to the creation of this entry.; (xsd)search:ItemTransactionRequest.entry.search>{0,0}
< Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.; (xsd)request:ItemTransactionRequest.entry.request>
< Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.; (xsd)response:ItemTransactionRequest.entry.response>{0,0}🔗 Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.ItemTransactionRequest.entry.request(xsd)(doc)=
<#base:Bundle.entry.request>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred. Binding: http-verb (required, HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details.); (xsd)method:code>
< The URL for this entry, relative to the root (the address to which the request is posted). E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]".; (xsd)url:uri>
< If the ETag values match, return a 304 Not Modified status. See the API documentation for ["Conditional Read"](http://hl7.org/fhir/R5/http.html#cread).; (xsd)ifNoneMatch:string>?
< Only perform the operation if the last updated date matches. See the API documentation for ["Conditional Read"](http://hl7.org/fhir/R5/http.html#cread).; (xsd)ifModifiedSince:instant>?
< Only perform the operation if the Etag value matches. For more information, see the API section ["Managing Resource Contention"](http://hl7.org/fhir/R5/http.html#concurrency).; (xsd)ifMatch:string>?
< Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for ["Conditional Create"](http://hl7.org/fhir/R5/http.html#ccreate). This is just the query portion of the URL - what follows the "?" (not including the "?").; (xsd)ifNoneExist:string>?🔗 Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.ItemTransactionRequest.entry.response(xsd)(doc)=
<#base:Bundle.entry.response>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.; (xsd)status:string>
< The location header created by processing this operation, populated if the operation returns a location.; (xsd)location:uri>?
< The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http://hl7.org/fhir/R5/http.html#versioning) and [Managing Resource Contention](http://hl7.org/fhir/R5/http.html#concurrency)). Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.; (xsd)etag:string>?
< The date/time that the resource was modified on the server. This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.; (xsd)lastModified:instant>?
< An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction. For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.
This outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.; (xsd)outcome:Resource>?🔗 Information about the search process that lead to the creation of this entry.ItemTransactionRequest.entry.search(xsd)(doc)=
<#base:Bundle.entry.search>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence. Binding: search-entry-mode (required, Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.); (xsd)mode:code>?
< When searching, the server's search ranking score for the entry. Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.
See [Patient Match](http://hl7.org/fhir/R5/patient-operation-match.html) for the EMPI search which relates to this element.; (xsd)score:decimal>?🔗 A series of links that provide context to this bundle. Both Bundle.link and Bundle.entry.link are defined to support providing additional context when Bundles are used (e.g. [HATEOAS](http://en.wikipedia.org/wiki/HATEOAS)).
Bundle.entry.link corresponds to links found in the HTTP header if the resource in the entry was [read](http://hl7.org/fhir/R5/http.html#read) directly.
This specification defines some specific uses of Bundle.link for [searching](http://hl7.org/fhir/R5/search.html#conformance) and [paging](http://hl7.org/fhir/R5/http.html#paging), but no specific uses for Bundle.entry.link, and no defined function in a transaction - the meaning is implementation specific. The behavior of navigation link types (next/prev/first/last) are well defined for searchset and history Bundles but are not currently defined for other types. Implementers who choose to use such link relationships for other bundle types will need to negotiate behavior with their interoperability partners.ItemTransactionRequest.link(xsd)(doc)=
<#base:Bundle.link>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A name which details the functional use for this link - see [http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1](http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1). Binding: iana-link-relations (required, ); (xsd)relation:code>
< The reference details for the link.; (xsd)url:uri>🔗 A container for a collection of resources.ItemTransactionResponse(xsd)(doc)=
<#base:Bundle>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< A persistent identifier for the bundle that won't change as a bundle is copied from server to server. Persistent identity generally only matters for batches of type Document, Message, and Collection. It would not normally be populated for search and history results and servers ignore Bundle.identifier when processing batches and transactions. For Documents the .identifier SHALL be populated such that the .identifier is globally unique.; (xsd)identifier:Identifier>?
< This transaction Bundle is to convey the response to a transaction request to create/update/delete/patch content of a catalog, from the Catalog Owner to the Catalog Custodian This transaction Bundle is usable with any kind of catalog (laboratory compendium, drug formulary, order sets, devices ...) Binding: bundle-type (required, Indicates the purpose of a bundle - how it is intended to be used.) transaction-response; (xsd)type:code>
< The date/time that the bundle was assembled - i.e. when the resources were placed in the bundle. For many bundles, the timestamp is equal to .meta.lastUpdated, because they are not stored (e.g. search results). When a bundle is placed in a persistent store, .meta.lastUpdated will be usually be changed by the server. When the bundle is a message, a middleware agent altering the message (even if not stored) SHOULD update .meta.lastUpdated. .timestamp is used to track the original time of the Bundle, and SHOULD be populated.
Usage:
* document : the date the document was created. Note: the composition may predate the document, or be associated with multiple documents. The date of the composition - the authoring time - may be earlier than the document assembly time
* message : the date that the content of the message was assembled. This date is not changed by middleware engines unless they add additional data that changes the meaning of the time of the message
* history : the date that the history was assembled. This time would be used as the _since time to ask for subsequent updates
* searchset : the time that the search set was assembled. Note that different pages MAY have different timestamps but need not. Having different timestamps does not imply that subsequent pages will represent or include changes made since the initial query
* transaction | transaction-response | batch | batch-response | collection : no particular assigned meaning
The timestamp value should be greater than the lastUpdated and other timestamps in the resources in the bundle, and it should be equal or earlier than the .meta.lastUpdated on the Bundle itself.; (xsd)timestamp:instant>?
< If a set of search matches, this is the (potentially estimated) total number of entries of type 'match' across all pages in the search. It does not include search.mode = 'include' or 'outcome' entries and it does not provide a count of the number of entries in the Bundle. Only used if the bundle is a search result set. The total does not include resources such as OperationOutcome and included resources, only the total number of matching resources.; (xsd)total:unsignedInt>?
[]< A series of links that provide context to this bundle. Both Bundle.link and Bundle.entry.link are defined to support providing additional context when Bundles are used (e.g. [HATEOAS](http://en.wikipedia.org/wiki/HATEOAS)).
Bundle.entry.link corresponds to links found in the HTTP header if the resource in the entry was [read](http://hl7.org/fhir/R5/http.html#read) directly.
This specification defines some specific uses of Bundle.link for [searching](http://hl7.org/fhir/R5/search.html#conformance) and [paging](http://hl7.org/fhir/R5/http.html#paging), but no specific uses for Bundle.entry.link, and no defined function in a transaction - the meaning is implementation specific. The behavior of navigation link types (next/prev/first/last) are well defined for searchset and history Bundles but are not currently defined for other types. Implementers who choose to use such link relationships for other bundle types will need to negotiate behavior with their interoperability partners.; (xsd)link:ItemTransactionResponse.link>*
[]< Each entry will contain a resource representing a catalog item or one of the supporting resources of a catalog item.
The resource will be followed by a request instructing the Catalog Custodian what action (create/update/delete/patch) to perform on this resource; (xsd)entry:ItemTransactionResponse.entry>+
< Digital Signature - base64 encoded. XML-DSig or a JWS. The signature could be created by the "author" of the bundle or by the originating device. Requirements around inclusion of a signature, verification of signatures and treatment of signed/non-signed bundles is implementation-environment specific.; (xsd)signature:Signature>?
< Captures issues and warnings that relate to the construction of the Bundle and the content within it. Usage notes: These issues and warnings must apply to the Bundle as a whole, not to individual entries.Messages relating to the processing of individual entries (e.g. in a batch or transaction) SHALL be reported in the entry.response.outcome for that entry. If there are errors that arise in the creation of the Bundle, then that should be handled by an OperationOutcome being returned instead of the Bundle.; (xsd)issues:OperationOutcome>?🔗 Each entry will contain a resource representing a catalog item or one of the supporting resources of a catalog item.
The resource will be followed by a request instructing the Catalog Custodian what action (create/update/delete/patch) to perform on this resourceItemTransactionResponse.entry(xsd)(doc)=
<#base:Bundle.entry>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< A series of links that provide context to this entry.; (xsd)link:Bundle.link>*
< The Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when:
* invoking a create
* invoking or responding to an operation where the body is not a single identified resource
* invoking or returning the results of a search or history operation. fullUrl might not be [unique in the context of a resource](http://hl7.org/fhir/R5/bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](http://hl7.org/fhir/R5/references.html), the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the [regex](http://hl7.org/fhir/R5/references.html#regex), then the 'id' portion of the fullUrl SHALL end with the Resource.id.
Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).; (xsd)fullUrl:uri>
< The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. This is allowed to be a Parameters resource if and only if it is referenced by something else within the Bundle that provides context/meaning.; (xsd)resource:Resource>
< Information about the search process that lead to the creation of this entry.; (xsd)search:ItemTransactionResponse.entry.search>{0,0}
< Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.; (xsd)request:ItemTransactionResponse.entry.request>{0,0}
< Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.; (xsd)response:ItemTransactionResponse.entry.response>🔗 Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.ItemTransactionResponse.entry.request(xsd)(doc)=
<#base:Bundle.entry.request>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred. Binding: http-verb (required, HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details.); (xsd)method:code>
< The URL for this entry, relative to the root (the address to which the request is posted). E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]".; (xsd)url:uri>
< If the ETag values match, return a 304 Not Modified status. See the API documentation for ["Conditional Read"](http://hl7.org/fhir/R5/http.html#cread).; (xsd)ifNoneMatch:string>?
< Only perform the operation if the last updated date matches. See the API documentation for ["Conditional Read"](http://hl7.org/fhir/R5/http.html#cread).; (xsd)ifModifiedSince:instant>?
< Only perform the operation if the Etag value matches. For more information, see the API section ["Managing Resource Contention"](http://hl7.org/fhir/R5/http.html#concurrency).; (xsd)ifMatch:string>?
< Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for ["Conditional Create"](http://hl7.org/fhir/R5/http.html#ccreate). This is just the query portion of the URL - what follows the "?" (not including the "?").; (xsd)ifNoneExist:string>?🔗 Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.ItemTransactionResponse.entry.response(xsd)(doc)=
<#base:Bundle.entry.response>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.; (xsd)status:string>
< The location header created by processing this operation, populated if the operation returns a location.; (xsd)location:uri>?
< The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http://hl7.org/fhir/R5/http.html#versioning) and [Managing Resource Contention](http://hl7.org/fhir/R5/http.html#concurrency)). Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.; (xsd)etag:string>?
< The date/time that the resource was modified on the server. This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.; (xsd)lastModified:instant>?
< An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction. For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.
This outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.; (xsd)outcome:Resource>?🔗 Information about the search process that lead to the creation of this entry.ItemTransactionResponse.entry.search(xsd)(doc)=
<#base:Bundle.entry.search>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence. Binding: search-entry-mode (required, Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.); (xsd)mode:code>?
< When searching, the server's search ranking score for the entry. Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.
See [Patient Match](http://hl7.org/fhir/R5/patient-operation-match.html) for the EMPI search which relates to this element.; (xsd)score:decimal>?🔗 A series of links that provide context to this bundle. Both Bundle.link and Bundle.entry.link are defined to support providing additional context when Bundles are used (e.g. [HATEOAS](http://en.wikipedia.org/wiki/HATEOAS)).
Bundle.entry.link corresponds to links found in the HTTP header if the resource in the entry was [read](http://hl7.org/fhir/R5/http.html#read) directly.
This specification defines some specific uses of Bundle.link for [searching](http://hl7.org/fhir/R5/search.html#conformance) and [paging](http://hl7.org/fhir/R5/http.html#paging), but no specific uses for Bundle.entry.link, and no defined function in a transaction - the meaning is implementation specific. The behavior of navigation link types (next/prev/first/last) are well defined for searchset and history Bundles but are not currently defined for other types. Implementers who choose to use such link relationships for other bundle types will need to negotiate behavior with their interoperability partners.ItemTransactionResponse.link(xsd)(doc)=
<#base:Bundle.link>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A name which details the functional use for this link - see [http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1](http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1). Binding: iana-link-relations (required, ); (xsd)relation:code>
< The reference details for the link.; (xsd)url:uri>🔗 The ChargeItemDefinition resource provides the properties that apply to the (billing) codes necessary to calculate costs and prices. The properties may differ largely depending on type and realm, therefore this resource gives only a rough structure and requires profiling for each type of billing code system.LabChargeItemDefinition(xsd)(doc)=
<#base:ChargeItemDefinition>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< An absolute URI that is used to identify this charge item definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this charge item definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the charge item definition is stored on different servers. Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.
The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](http://hl7.org/fhir/R5/resource.html#versions).
In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](http://hl7.org/fhir/R5/resource.html#meta) element to indicate where the current master source of the resource can be found.; (xsd)url:uri>?
[]< A formal identifier that is used to identify this charge item definition when it is represented in other formats, or referenced in a specification, model, design or an instance. Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this charge item definition outside of FHIR, where it is not possible to use the logical URI.; (xsd)identifier:Identifier>*
< The identifier that is used to identify this version of the charge item definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the charge item definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active assets. There may be different charge item definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the charge item definition with the format [url]|[version]. The version SHOULD NOT contain a '#' - see [Business Version](http://hl7.org/fhir/R5/resource.html#bv-format).; (xsd)version:string>?
< Indicates the mechanism used to compare versions to determine which is more current. If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined. Binding: version-algorithm (extensible, ); (xsd)versionAlgorithm:(<Coding>
|<string>)>?
< A natural language name identifying the ChargeItemDefinition. This name should be usable as an identifier for the module by machine processing applications such as code generation. The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.; (xsd)name:string>?
< A short, descriptive, user-friendly title for the charge item definition. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.; (xsd)title:LabChargeItemDefinition.title>?
[]< The URL pointing to an externally-defined charge item definition that is adhered to in whole or in part by this definition.; (xsd)derivedFromUri:uri>*
[]< A larger definition of which this particular definition is a component or step.; (xsd)partOf:ChargeItemDefinition*>*
[]< As new versions of a protocol or guideline are defined, allows identification of what versions are replaced by a new instance.; (xsd)replaces:ChargeItemDefinition*>*
< The current state of the ChargeItemDefinition. Allows filtering of charge item definitions that are appropriate for use versus not.
See guidance around (not) making local changes to elements [here](http://hl7.org/fhir/R5/canonicalresource.html#localization). Binding: publication-status (required, The lifecycle status of an artifact.); (xsd)status:code>
< A Boolean value to indicate that this charge item definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. Allows filtering of charge item definitions that are appropriate for use versus not.; (xsd)experimental:boolean>?
< The date (and optionally time) when the charge item definition was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the charge item definition changes. The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the charge item definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
See guidance around (not) making local changes to elements [here](http://hl7.org/fhir/R5/canonicalresource.html#localization).; (xsd)date:dateTime>?
< The name of the organization or individual responsible for the release and ongoing maintenance of the charge item definition. Usually an organization but may be an individual. The publisher (or steward) of the charge item definition is the organization or individual primarily responsible for the maintenance and upkeep of the charge item definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the charge item definition. This item SHOULD be populated unless the information is available from context.; (xsd)publisher:string>?
[]< Contact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc.
See guidance around (not) making local changes to elements [here](http://hl7.org/fhir/R5/canonicalresource.html#localization).; (xsd)contact:ContactDetail>*
< A free text natural language description of the charge item definition from a consumer's perspective. This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the charge item definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the charge item definition is presumed to be the predominant language in the place the charge item definition was created).; (xsd)description:markdown>?
[]< The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate charge item definition instances. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.; (xsd)useContext:UsageContext>*
[]< A legal or geographic region in which the charge item definition is intended to be used. It may be possible for the charge item definition to be used in jurisdictions other than those for which it was originally designed or intended.
DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.) Binding: jurisdiction (extensible, Countries and regions within which this artifact is targeted for use.); (xsd)jurisdiction:CodeableConcept>*
< Explanation of why this charge item definition is needed and why it has been designed as it has. This element does not describe the usage of the charge item definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this charge item definition.; (xsd)purpose:markdown>?
< A copyright statement relating to the charge item definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the charge item definition.; (xsd)copyright:markdown>?
< A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved'). The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.; (xsd)copyrightLabel:string>?
< The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.
See guidance around (not) making local changes to elements [here](http://hl7.org/fhir/R5/canonicalresource.html#localization).; (xsd)approvalDate:date>?
< The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. If specified, this date follows the original approval date.
See guidance around (not) making local changes to elements [here](http://hl7.org/fhir/R5/canonicalresource.html#localization).; (xsd)lastReviewDate:date>?
< The defined billing details in this resource pertain to the given billing code. Binding: chargeitem-billingcodes (example, Billing Code defined by this ChargeItemDefinition.); (xsd)code:CodeableConcept>
[]< The defined billing details in this resource pertain to the given product instance(s). In case of highly customized, individually produced or fitted devices/substances, the pricing information may be different for each instance of the product. This reference links pricing details to specific product instances.; (xsd)instance:(<ActivityDefinition>
|<Device>
|<DeviceDefinition>
|<HealthcareService>
|<Medication>
|<PlanDefinition>
|<Substance>)>*
[]< Expressions that describe applicability criteria for the billing code. The applicability conditions can be used to ascertain whether a billing item is allowed in a specific context. E.g. some billing codes may only be applicable in out-patient settings, only to male/female patients or only to children.; (xsd)applicability:LabChargeItemDefinition.applicability>*
[]< Group of properties which are applicable under the same conditions. If no applicability rules are established for the group, then all properties always apply.; (xsd)propertyGroup:LabChargeItemDefinition.propertyGroup>*
[]< The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate charge item definition instances. When multiple clinical focus contexts are specified the billing code is applicable if at least one of these contexts is present in the instance; (xsd)ClinicalFocus:LabChargeItemDefinition.ClinicalFocus>*🔗 Expressions that describe applicability criteria for the billing code. The applicability conditions can be used to ascertain whether a billing item is allowed in a specific context. E.g. some billing codes may only be applicable in out-patient settings, only to male/female patients or only to children.LabChargeItemDefinition.applicability(xsd)(doc)=
<#base:ChargeItemDefinition.applicability>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< An expression that returns true or false, indicating whether the condition is satisfied. When using FHIRPath expressions, the %context environment variable must be replaced at runtime with the ChargeItem resource to which this definition is applied. Please note that FHIRPath Expressions can only be evaluated in the scope of the current ChargeItem resource to which this definition is being applied.
FHIRPath expressions can traverse into other resources linked from the ChargeItem resource, however, testing rules such as that a billing code may be billed only once per encounter need a wider scope. In such scenarios, CQL may be the appropriate choice.; (xsd)condition:Expression>?
< The period during which the charge item definition content was or is planned to be in active use. The effective period for a charge item definition determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 might be published in 2015.; (xsd)effectivePeriod:Period>?
< Reference to / quotation of the external source of the group of properties.; (xsd)relatedArtifact:RelatedArtifact>?🔗 The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate charge item definition instances. When multiple clinical focus contexts are specified the billing code is applicable if at least one of these contexts is present in the instanceLabChargeItemDefinition.ClinicalFocus(xsd)(doc)=
<#base:UsageContext>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< A code that identifies the type of context being specified by this usage context. Binding: http://terminology.hl7.org/ValueSet/usage-context-type (extensible, A code that specifies a type of context being specified by a usage context.); (xsd)code:LabChargeItemDefinition.ClinicalFocus.code>
< A value that defines the context specified in this context of use. The interpretation of the value is defined by the code. Binding: use-context (example, A code that defines the specific value for the context being specified.); (xsd)value:LabChargeItemDefinition.ClinicalFocus.value[x]>🔗 A code that identifies the type of context being specified by this usage context. Binding: http://terminology.hl7.org/ValueSet/usage-context-type (extensible, A code that specifies a type of context being specified by a usage context.)LabChargeItemDefinition.ClinicalFocus.code(xsd)(doc)=
<#base:Coding>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< 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 be an absolute reference to some definition that establishes the system clearly and unambiguously. http://terminology.hl7.org/CodeSystem/usage-context-type; (xsd)system:uri>?
< 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.; (xsd)version:string>?
< 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). focus; (xsd)code>?
< A representation of the meaning of the code in the system, following the rules of the system.; (xsd)display:string>?
< 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.; (xsd)userSelected:boolean>?🔗 A value that defines the context specified in this context of use. The interpretation of the value is defined by the code. Binding: use-context (example, A code that defines the specific value for the context being specified.)LabChargeItemDefinition.ClinicalFocus.value[x](xsd)(doc)=
<#base:CodeableConcept>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< 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. Binding: example-clinical-focus (example, All contexts for any laboratory test); (xsd)coding:Coding>*
< 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.; (xsd)text:string>?🔗 Group of properties which are applicable under the same conditions. If no applicability rules are established for the group, then all properties always apply.LabChargeItemDefinition.propertyGroup(xsd)(doc)=
<#base:ChargeItemDefinition.propertyGroup>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< Expressions that describe applicability criteria for the priceComponent. The applicability conditions can be used to ascertain whether a billing item is allowed in a specific context. E.g. some billing codes may only be applicable in out-patient settings, only to male/female patients or only to children.; (xsd)applicability:ChargeItemDefinition.applicability>*
[]< The price for a ChargeItem may be calculated as a base price with surcharges/deductions that apply in certain conditions. A ChargeItemDefinition resource that defines the prices, factors and conditions that apply to a billing code is currently under development. The priceComponent element can be used to offer transparency to the recipient of the Invoice of how the prices have been calculated.; (xsd)priceComponent:MonetaryComponent>*🔗 A short, descriptive, user-friendly title for the charge item definition. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.LabChargeItemDefinition.title(xsd)(doc)=
<#base:string>
< unique id for the element within a resource (for internal references); (xsd)id:string>?
[]< An Extension; (xsd)extension:Extension>*
< The actual value; (xsd)value:string>?
[]< Language translation from base language of resource to another language.; (xsd)LanguageSynonym:Extension>*🔗 Set of definitional characteristics for a kind of observation or measurement produced or consumed by an orderable health care service. An instance of this resource informs the consumer of a health-related service (such as a lab diagnostic test or panel) about how the observations used or produced by this service will look like.LabObservationDefinition(xsd)(doc)=
<#base:ObservationDefinition>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< An absolute URL that is used to identify this ObservationDefinition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this ObservationDefinition is (or will be) published. The URL SHOULD include the major version of the ObservationDefinition. For more information see Technical and Business Versions. Can be a urn:uuid: or a urn:oid:, but real http: addresses are preferred. This is the URI that will be used when making canonical references to this resource.; (xsd)url:uri>?
< Business identifiers assigned to this ObservationDefinition. by the performer and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server. This is a business identifier, not a resource identifier. It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types.; (xsd)identifier:Identifier>?
< The identifier that is used to identify this version of the ObservationDefinition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the ObservationDefinition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions are orderable. There may be multiple different instances of an observationDefinition that have the same identifier but different versions.; (xsd)version:string>?
< Indicates the mechanism used to compare versions to determine which is more current. If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined. Binding: version-algorithm (extensible, ); (xsd)versionAlgorithm:(<Coding>
|<string>)>?
< A natural language name identifying the ObservationDefinition. This name should be usable as an identifier for the module by machine processing applications such as code generation. The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.; (xsd)name:string>?
< A short, descriptive, user-friendly title for the ObservationDefinition.; (xsd)title:string>?
< The current state of the ObservationDefinition. A nominal state-transition diagram can be found in the [Definition pattern](http://hl7.org/fhir/R5/definition.html#statemachine) documentation
Unknown does not represent "other" - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is.
See guidance around (not) making local changes to elements [here](http://hl7.org/fhir/R5/canonicalresource.html#localization). Binding: publication-status (required, Codes identifying the state of an ObservationDefinition.); (xsd)status:code>
< A flag to indicate that this ObservationDefinition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage. Allows filtering of ObservationDefinition that are appropriate for use vs. not.; (xsd)experimental:boolean>?
< The date (and optionally time) when the ObservationDefinition was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the ObservationDefinition changes. The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the ObservationDefinition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
See guidance around (not) making local changes to elements [here](http://hl7.org/fhir/R5/canonicalresource.html#localization).; (xsd)date:dateTime>?
< Helps establish the "authority/credibility" of the ObservationDefinition. May also allow for contact.; (xsd)publisher:string>?
[]< Contact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc.
See guidance around (not) making local changes to elements [here](http://hl7.org/fhir/R5/canonicalresource.html#localization).; (xsd)contact:ContactDetail>*
< A free text natural language description of the ObservationDefinition from the consumer's perspective. This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the module as conveyed in the text field of the resource itself. This item SHOULD be populated unless the information is available from context.; (xsd)description:markdown>?
[]< The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate ObservationDefinition instances. When multiple usageContexts are specified, there is no expectation for whether all or any of the contexts apply.; (xsd)useContext:UsageContext>*
[]< A jurisdiction in which the ObservationDefinition is intended to be used. It may be possible for the ObservationDefinition to be used in jurisdictions other than those for which it was originally designed or intended.
DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.) Binding: jurisdiction (extensible, Codes for country, country subdivision and region for indicating where a resource is intended to be used.); (xsd)jurisdiction:CodeableConcept>*
< Explains why this ObservationDefinition is needed and why it has been designed as it has. This element does not describe the usage of the ObservationDefinition. Rather it is for traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this ObservationDefinition.; (xsd)purpose:markdown>?
< Copyright statement relating to the ObservationDefinition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the ObservationDefinition.; (xsd)copyright:markdown>?
< A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved'). The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.; (xsd)copyrightLabel:string>?
< The date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usage. The date may be more recent than the approval date because of minor changes / editorial corrections.
See guidance around (not) making local changes to elements [here](http://hl7.org/fhir/R5/canonicalresource.html#localization).; (xsd)approvalDate:date>?
< The date on which the asset content was last reviewed. Review happens periodically after that, but doesn't change the original approval date. If specified, this is usually after the approval date.
See guidance around (not) making local changes to elements [here](http://hl7.org/fhir/R5/canonicalresource.html#localization).; (xsd)lastReviewDate:date>?
< The period during which the ObservationDefinition content was or is planned to be effective. The effective period for an ObservationDefinition determines when the content is applicable for usage and is independent of publication and review dates. For example, an observation definition intended to be used for the year 2021 might be published in 2020.
See guidance around (not) making local changes to elements [here](http://hl7.org/fhir/R5/canonicalresource.html#localization).; (xsd)effectivePeriod:Period>?
[]< The canonical URL pointing to another FHIR-defined ObservationDefinition that is adhered to in whole or in part by this definition.; (xsd)derivedFromCanonical:ObservationDefinition*>*
[]< The URL pointing to an externally-defined observation definition, guideline or other definition that is adhered to in whole or in part by this definition.; (xsd)derivedFromUri:uri>*
[]< A code that describes the intended kind of subject of Observation instances conforming to this ObservationDefinition. Examples: person, animal, device, air, surface ….; (xsd)subject:CodeableConcept>*
< The type of individual/organization/device that is expected to act upon instances of this definition.; (xsd)performerType:CodeableConcept>?
[]< A code that classifies the general type of observation. This element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used for one instance of ObservationDefinition. The level of granularity is defined by the category concepts in the value set. Binding: observation-category (example, Codes for high level observation categories.); (xsd)category:CodeableConcept>*
< Describes what will be observed. Sometimes this is called the observation "name". Binding: observation-codes (example, Codes identifying names of simple observations.); (xsd)code:LabObservationDefinition.code>
[]< The data types allowed for the value element of the instance observations conforming to this ObservationDefinition. Binding: permitted-data-type (required, Permitted data type for observation value.); (xsd)permittedDataType:code>*
< Multiple results allowed for observations conforming to this ObservationDefinition. An example of observation allowing multiple results is "bacteria identified by culture". Conversely, the measurement of a potassium level allows a single result.; (xsd)multipleResultsAllowed:boolean>?
< The site on the subject's body where the observation is to be made. Only used if the defined observation is to be made directly on a body part and if this body part is not implied by code found in ObservationDefinition.code. Not used for in vitro diagnostic observations.
Example: 14975008 |Forearm structure|. Binding: body-site (example, SNOMED CT body structures.); (xsd)bodySite:CodeableConcept>?
< The method or technique used to perform the observation. Only used if not implicit in observation code
Example: 702659008 |Automated count technique|. Binding: observation-methods (example, Methods for simple observations.); (xsd)method:CodeableConcept>?
[]< The kind of specimen that this type of observation is produced on. Only used for in vitro observations. When multiple occurrences of specimen are present, they are to be combined with a logical AND: all specified specimens are needed for the observation.; (xsd)specimen:SpecimenDefinition*>*
[]< The measurement model of device or actual device used to produce observations of this type. When multiple occurrences of device are present, they are to be combined with a logical OR: at least one of the specified devices is used to produce the observation.; (xsd)device:(<Device>
|<DeviceDefinition>)>*
< The preferred name to be used when reporting the results of observations conforming to this ObservationDefinition.; (xsd)preferredReportName:string>?
[]< Units allowed for the valueQuantity element in the instance observations conforming to this ObservationDefinition. Binding: ucum-units (preferred, Codes identifying units of measure.); (xsd)permittedUnit:LabObservationDefinition.permittedUnit>*
[]< A set of qualified values associated with a context and a set of conditions - provides a range for quantitative and ordinal observations and a collection of value sets for qualitative observations.; (xsd)qualifiedValue:LabObservationDefinition.qualifiedValue>*
[]< This ObservationDefinition defines a group observation (e.g. a battery, a panel of tests, a set of vital sign measurements) that includes the target as a member of the group.; (xsd)hasMember:(<ObservationDefinition>
|<Questionnaire>)>*
[]< Some observations have multiple component observations, expressed as separate code value pairs.; (xsd)component:LabObservationDefinition.component>*🔗 Describes what will be observed. Sometimes this is called the observation "name". Binding: observation-codes (example, Codes identifying names of simple observations.)LabObservationDefinition.code(xsd)(doc)=
<#base:CodeableConcept>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< 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.; (xsd)coding:Coding>*
< 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.; (xsd)text:string>?
< 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.; (xsd)LOINC:LabObservationDefinition.code.LOINC>?🔗 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.LabObservationDefinition.code.LOINC(xsd)(doc)=
<#base:Coding>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< 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 be an absolute reference to some definition that establishes the system clearly and unambiguously. http://loinc.org; (xsd)system:uri>?
< 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.; (xsd)version:string>?
< 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).; (xsd)code>?
< A representation of the meaning of the code in the system, following the rules of the system.; (xsd)display:string>?
< 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.; (xsd)userSelected:boolean>?🔗 Some observations have multiple component observations, expressed as separate code value pairs.LabObservationDefinition.component(xsd)(doc)=
<#base:ObservationDefinition.component>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Describes what will be observed. Binding: observation-codes (example, Codes identifying names of simple observations.); (xsd)code:CodeableConcept>
[]< The data types allowed for the value element of the instance of this component observations. Binding: permitted-data-type (required, Permitted data type for observation value.); (xsd)permittedDataType:code>*
[]< Units allowed for the valueQuantity element in the instance observations conforming to this ObservationDefinition. Binding: ucum-units (preferred, Codes identifying units of measure.); (xsd)permittedUnit:Coding>*
[]< A set of qualified values associated with a context and a set of conditions - provides a range for quantitative and ordinal observations and a collection of value sets for qualitative observations.; (xsd)qualifiedValue:ObservationDefinition.qualifiedValue>*🔗 Units allowed for the valueQuantity element in the instance observations conforming to this ObservationDefinition. Binding: ucum-units (preferred, Codes identifying units of measure.)LabObservationDefinition.permittedUnit(xsd)(doc)=
<#base:Coding>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< 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 be an absolute reference to some definition that establishes the system clearly and unambiguously. http://unitsofmeasure.org; (xsd)system:uri>?
< 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.; (xsd)version:string>?
< 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).; (xsd)code>?
< A representation of the meaning of the code in the system, following the rules of the system.; (xsd)display:string>?
< 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.; (xsd)userSelected:boolean>?🔗 A set of qualified values associated with a context and a set of conditions - provides a range for quantitative and ordinal observations and a collection of value sets for qualitative observations.LabObservationDefinition.qualifiedValue(xsd)(doc)=
<#base:ObservationDefinition.qualifiedValue>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A concept defining the context for this set of qualified values. Binding: referencerange-meaning (extensible, ); (xsd)context:CodeableConcept>?
[]< The target population this set of qualified values applies to. If this element is not present then the global population is assumed. Binding: referencerange-appliesto (example, ); (xsd)appliesTo:CodeableConcept>*
< The gender this set of qualified values applies to. Binding: administrative-gender (required, ); (xsd)gender:code>?
< The age range this set of qualified values applies to. Some analytes vary greatly over age.; (xsd)age:Range>?
< The gestational age this set of qualified values applies to.; (xsd)gestationalAge:Range>?
< Text based condition for which the the set of qualified values is valid.; (xsd)condition:string>?
< The category of range of values for continuous or ordinal observations that match the criteria of this set of qualified values. Binding: observation-range-category (required, ); (xsd)rangeCategory:code>?
< The range of values defined for continuous or ordinal observations that match the criteria of this set of qualified values.; (xsd)range:Range>?
< The set of valid coded results for qualitative observations that match the criteria of this set of qualified values.; (xsd)validCodedValueSet:ValueSet*>?
< The set of normal coded results for qualitative observations that match the criteria of this set of qualified values.; (xsd)normalCodedValueSet:ValueSet*>?
< The set of abnormal coded results for qualitative observations that match the criteria of this set of qualified values.; (xsd)abnormalCodedValueSet:ValueSet*>?
< The set of critical coded results for qualitative observations that match the criteria of this set of qualified values.; (xsd)criticalCodedValueSet:ValueSet*>?🔗 This resource allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context.LabProcedureDefinition(xsd)(doc)=
<#base:ActivityDefinition>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< An absolute URI that is used to identify this activity definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this activity definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the activity definition is stored on different servers. Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.
The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](http://hl7.org/fhir/R5/resource.html#versions).
In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](http://hl7.org/fhir/R5/resource.html#meta) element to indicate where the current master source of the resource can be found.; (xsd)url:uri>
[]< A formal identifier that is used to identify this activity definition when it is represented in other formats, or referenced in a specification, model, design or an instance. Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this activity definition outside of FHIR, where it is not possible to use the logical URI.; (xsd)identifier:Identifier>*
< The identifier that is used to identify this version of the activity definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the activity definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active assets. There may be different activity definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the activity definition with the format [url]|[version]. The version SHOULD NOT contain a '#' - see [Business Version](http://hl7.org/fhir/R5/resource.html#bv-format).; (xsd)version:string>?
< Indicates the mechanism used to compare versions to determine which is more current. If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined. Binding: version-algorithm (extensible, ); (xsd)versionAlgorithm:(<Coding>
|<string>)>?
< A natural language name identifying the activity definition. This name should be usable as an identifier for the module by machine processing applications such as code generation. The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.; (xsd)name:string>?
< A short, descriptive, user-friendly title for the activity definition. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.; (xsd)title:LabProcedureDefinition.title>?
< An explanatory or alternate title for the activity definition giving additional information about its content.; (xsd)subtitle:string>?
< The status of this activity definition. Enables tracking the life-cycle of the content. Allows filtering of activity definitions that are appropriate for use versus not.
See guidance around (not) making local changes to elements [here](http://hl7.org/fhir/R5/canonicalresource.html#localization). Binding: publication-status (required, The lifecycle status of an artifact.); (xsd)status:code>
< A Boolean value to indicate that this activity definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. Allows filtering of activity definitions that are appropriate for use versus not.; (xsd)experimental:boolean>?
< A code, group definition, or canonical reference that describes or identifies the intended subject of the activity being defined. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource. Note that the choice of canonical for the subject element was introduced in R4B to support pharmaceutical quality use cases. To ensure as much backwards-compatibility as possible, it is recommended to only use the new canonical type with these use cases. Binding: participant-resource-types (extensible, The possible types of subjects for an activity (E.g. Patient, Practitioner, Organization, Location, etc.).); (xsd)subject:(<AdministrableProductDefinition>
|<CodeableConcept>
|<EvidenceVariable>
|<Group>
|<ManufacturedItemDefinition>
|<MedicinalProductDefinition>
|<PackagedProductDefinition>
|<SubstanceDefinition>)>?
< The date (and optionally time) when the activity definition was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the activity definition changes. The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the activity definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
See guidance around (not) making local changes to elements [here](http://hl7.org/fhir/R5/canonicalresource.html#localization).; (xsd)date:dateTime>?
< The name of the organization or individual responsible for the release and ongoing maintenance of the activity definition. Usually an organization but may be an individual. The publisher (or steward) of the activity definition is the organization or individual primarily responsible for the maintenance and upkeep of the activity definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the activity definition. This item SHOULD be populated unless the information is available from context.; (xsd)publisher:string>?
[]< Contact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc.
See guidance around (not) making local changes to elements [here](http://hl7.org/fhir/R5/canonicalresource.html#localization).; (xsd)contact:LabProcedureDefinition.contact>*
< A free text natural language description of the laboratory procedure from a consumer's perspective. This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the activity definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the activity definition is presumed to be the predominant language in the place the activity definition was created).; (xsd)description:markdown>?
[]< The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate activity definition instances. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.; (xsd)useContext:UsageContext>*
[]< A legal or geographic region in which the activity definition is intended to be used. It may be possible for the activity definition to be used in jurisdictions other than those for which it was originally designed or intended.
DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.) Binding: jurisdiction (extensible, Countries and regions within which this artifact is targeted for use.); (xsd)jurisdiction:CodeableConcept>*
< Explanation of why this activity definition is needed and why it has been designed as it has. This element does not describe the usage of the activity definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this activity definition.; (xsd)purpose:markdown>?
< A detailed description of how the activity definition is used from a clinical perspective.; (xsd)usage:markdown>?
< A copyright statement relating to the activity definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the activity definition. The short copyright declaration (e.g. (c) '2015+ xyz organization' should be sent in the copyrightLabel element.; (xsd)copyright:markdown>?
< A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved'). The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.; (xsd)copyrightLabel:string>?
< The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.
See guidance around (not) making local changes to elements [here](http://hl7.org/fhir/R5/canonicalresource.html#localization).; (xsd)approvalDate:date>?
< The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. If specified, this date follows the original approval date.
See guidance around (not) making local changes to elements [here](http://hl7.org/fhir/R5/canonicalresource.html#localization).; (xsd)lastReviewDate:date>?
< The period during which the activity definition content was or is planned to be in active use. The effective period for an activity definition determines when the content is applicable for usage and is independent of publication and review dates. For example, a activity intended to be used for the year 2016 might be published in 2015.
See guidance around (not) making local changes to elements [here](http://hl7.org/fhir/R5/canonicalresource.html#localization).; (xsd)effectivePeriod:LabProcedureDefinition.effectivePeriod>?
[]< Descriptive topics related to the content of the activity. Topics provide a high-level categorization of the activity that can be useful for filtering and searching. Examples could be lab specialties: chemistry, hormonology, hematology, bacteriology, virology ..
Other examples might list medical specialty of orderer: cardiology, dermatology, gastroenterology ... Binding: definition-topic (example, High-level categorization of the definition, used for searching, sorting, and filtering.); (xsd)topic:CodeableConcept>*
[]< An individiual or organization primarily involved in the creation and maintenance of the content.; (xsd)author:ContactDetail>*
[]< An individual or organization primarily responsible for internal coherence of the content.; (xsd)editor:ContactDetail>*
[]< An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the content. See guidance around (not) making local changes to elements [here](http://hl7.org/fhir/R5/canonicalresource.html#localization).; (xsd)reviewer:ContactDetail>*
[]< An individual or organization asserted by the publisher to be responsible for officially endorsing the content for use in some setting. See guidance around (not) making local changes to elements [here](http://hl7.org/fhir/R5/canonicalresource.html#localization).; (xsd)endorser:ContactDetail>*
[]< Related artifacts such as additional documentation, justification, or bibliographic references. Each related artifact is either an attachment, or a reference to another resource, but not both.; (xsd)relatedArtifact:RelatedArtifact>*
[]< A reference to a Library resource containing any formal logic used by the activity definition.; (xsd)library:Library*>*
< A description of the kind of resource the activity definition is representing. For example, a MedicationRequest, a ServiceRequest, or a CommunicationRequest. The kind element may only specify Request resource types to facilitate considering user input as part of processing the result of any automated clinical reasoning processes. To support creation of event resources, such as Observations, RiskAssessments, and DetectedIssues, use a Task resource with the focus of the task set to the event resource to be created. Note that the kind of resource to be created may determine what types of extensions are permitted. Binding: request-resource-types (required, The kind of activity the definition is describing.) ServiceRequest; (xsd)kind:code>
< A profile to which the target of the activity definition is expected to conform.; (xsd)profile:StructureDefinition*>?
< Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter. Tends to be less relevant for activities involving particular products. Binding: procedure-code (example, Detailed type of the activity; e.g. CBC.); (xsd)code:LabProcedureDefinition.code>?
< Indicates the level of authority/intentionality associated with the activity and where the request should fit into the workflow chain. Binding: request-intent (required, Codes indicating the degree of authority/intentionality associated with a request.); (xsd)intent:code>?
< Indicates how quickly the activity should be addressed with respect to other requests. Binding: request-priority (required, Identifies the level of importance to be assigned to actioning the request.); (xsd)priority:code>?
< Set this to true if the definition is to indicate that a particular activity should NOT be performed. If true, this element should be interpreted to reinforce a negative coding. For example NPO as a code with a doNotPerform of true would still indicate to NOT perform the action. This element is not intended to be used to communicate a decision support response to cancel an order in progress. That should be done with the "remove" type of a PlanDefinition or RequestOrchestration.; (xsd)doNotPerform:boolean>{0,0}
< The timing or frequency upon which the described activity is to occur. The intent of the timing element is to provide timing when the action should be performed. As a definitional resource, this timing is interpreted as part of an apply operation so that the timing of the result actions in a CarePlan or RequestOrchestration, for example, would be specified by evaluating the timing definition in the context of the apply and setting the resulting timing on the appropriate elements of the target resource. If the timing is an Age, the activity is expected to be performed when the subject is the given Age. When the timing is a Duration, the activity is expected to be performed within the specified duration from the apply. When the timing is a Range, it may be a range of Ages or Durations, providing a range for the expected timing of the resulting activity. When the timing is a Timing, it is establishing a schedule for the timing of the resulting activity.; (xsd)timing:(<Age>
|<Duration>
|<Range>
|<Timing>)>?
< If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example "pain", "on flare-up", etc. Binding: medication-as-needed-reason (example, A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc.); (xsd)asNeeded:(<boolean>
|<CodeableConcept>)>?
< Identifies the facility where the laboratory procedure will occur, and where the specimens will be conveyed May be tha laboratory as a whole or its work area facility or a sector of it; (xsd)location:Location*>?
[]< Indicates who should participate in performing the action described.; (xsd)participant:LabProcedureDefinition.participant>*
< Identifies the food, drug or other product being consumed or supplied in the activity. Binding: medication-codes (example, Code describing the type of substance or medication.); (xsd)product:(<CodeableConcept>
|<Ingredient>
|<Medication>
|<Substance>
|<SubstanceDefinition>)>?
< Identifies the quantity expected to be consumed at once (per dose, per meal, etc.).; (xsd)quantity:SimpleQuantity>?
[]< Provides detailed dosage instructions in the same way that they are described for MedicationRequest resources. If a dosage instruction is used, the definition should not specify timing or quantity.; (xsd)dosage:Dosage>*
[]< Indicates the sites on the subject's body where the procedure should be performed (I.e. the target sites). Only used if not implicit in the code found in ServiceRequest.type. Binding: body-site (example, A code that identifies the anatomical location.); (xsd)bodySite:CodeableConcept>*
[]< Defines specimen requirements for the laboratory procedure (test or panel) to be performed.; (xsd)specimenRequirement:LabSpecimenDefinition*>*
[]< Defines observation requirements for the laboratory procedure (test or panel) to be performed, such as body weight or surface area.; (xsd)observationRequirement:InputObservationDefinition*>*
[]< Defines the observations that are expected to be produced by the laboratory procedure.; (xsd)observationResultRequirement:LabObservationDefinition*>*
< A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input. Note that if both a transform and dynamic values are specified, the dynamic values will be applied to the result of the transform.; (xsd)transform:StructureMap*>?
[]< Dynamic values that will be evaluated to produce values for elements of the resulting resource. For example, if the dosage of a medication must be computed based on the patient's weight, a dynamic value would be used to specify an expression that calculated the weight, and the path on the request resource that would contain the result. Dynamic values are applied in the order in which they are defined in the ActivityDefinition. Note that if both a transform and dynamic values are specified, the dynamic values will be applied to the result of the transform.; (xsd)dynamicValue:LabProcedureDefinition.dynamicValue>*🔗 Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter. Tends to be less relevant for activities involving particular products. Binding: procedure-code (example, Detailed type of the activity; e.g. CBC.)LabProcedureDefinition.code(xsd)(doc)=
<#base:CodeableConcept>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< 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.; (xsd)coding:Coding>*
< 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.; (xsd)text:string>?
< 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.; (xsd)orderCodeLOINC:LabProcedureDefinition.code.orderCodeLOINC>?🔗 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.LabProcedureDefinition.code.orderCodeLOINC(xsd)(doc)=
<#base:Coding>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< 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 be an absolute reference to some definition that establishes the system clearly and unambiguously. http://loinc.org; (xsd)system:uri>?
< 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.; (xsd)version:string>?
< 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).; (xsd)code>?
< A representation of the meaning of the code in the system, following the rules of the system.; (xsd)display:string>?
< 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.; (xsd)userSelected:boolean>?🔗 Contact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc.
See guidance around (not) making local changes to elements [here](http://hl7.org/fhir/R5/canonicalresource.html#localization).LabProcedureDefinition.contact(xsd)(doc)=
<#base:ContactDetail>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< The name of an individual to contact. If there is no named individual, the telecom information is for the organization as a whole.; (xsd)name:string>?
[]< The contact details for the individual (if a name was provided) or the organization.; (xsd)telecom:ContactPoint>*🔗 Dynamic values that will be evaluated to produce values for elements of the resulting resource. For example, if the dosage of a medication must be computed based on the patient's weight, a dynamic value would be used to specify an expression that calculated the weight, and the path on the request resource that would contain the result. Dynamic values are applied in the order in which they are defined in the ActivityDefinition. Note that if both a transform and dynamic values are specified, the dynamic values will be applied to the result of the transform.LabProcedureDefinition.dynamicValue(xsd)(doc)=
<#base:ActivityDefinition.dynamicValue>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The path to the element to be customized. This is the path on the resource that will hold the result of the calculation defined by the expression. The specified path SHALL be a FHIRPath resolvable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. 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](http://hl7.org/fhir/R5/fhirpath.html#simple) for full details). The path attribute contains a [Simple FHIRPath Subset](http://hl7.org/fhir/R5/fhirpath.html#simple) that allows path traversal, but not calculation.; (xsd)path:string>
< An expression specifying the value of the customized element. The expression may be inlined, or may be a reference to a named expression within a logic library referenced by the library element.; (xsd)expression:Expression>🔗 The period during which the activity definition content was or is planned to be in active use. The effective period for an activity definition determines when the content is applicable for usage and is independent of publication and review dates. For example, a activity intended to be used for the year 2016 might be published in 2015.
See guidance around (not) making local changes to elements [here](http://hl7.org/fhir/R5/canonicalresource.html#localization).LabProcedureDefinition.effectivePeriod(xsd)(doc)=
<#base:Period>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< 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.; (xsd)start:dateTime>?
< The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. The end value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.; (xsd)end:dateTime>?🔗 Indicates who should participate in performing the action described.LabProcedureDefinition.participant(xsd)(doc)=
<#base:ActivityDefinition.participant>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The type of participant in the action. Binding: action-participant-type (required, The type of participant in the activity.); (xsd)type:code>?
< The type of participant in the action.; (xsd)typeCanonical:CapabilityStatement*>?
< The type of participant in the action. When this element is a reference, it SHOULD be a reference to a definitional resource (for example, a location type, rather than a specific location).; (xsd)typeReference:(<CareTeam>
|<Device>
|<DeviceDefinition>
|<Endpoint>
|<Group>
|<HealthcareService>
|<Location>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>?
< The role the participant should play in performing the described action. Binding: http://terminology.hl7.org/ValueSet/action-participant-role (example, Defines roles played by participants for the action.); (xsd)role:CodeableConcept>?
< Indicates how the actor will be involved in the action - author, reviewer, witness, etc. Binding: action-participant-function (example, ); (xsd)function:CodeableConcept>?🔗 A short, descriptive, user-friendly title for the activity definition. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.LabProcedureDefinition.title(xsd)(doc)=
<#base:string>
< unique id for the element within a resource (for internal references); (xsd)id:string>?
[]< An Extension; (xsd)extension:Extension>*
< The actual value; (xsd)value:string>?
[]< Language translation from base language of resource to another language.; (xsd)OtherTitle:Extension>*🔗 This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical and non-clinical artifacts such as clinical decision support rules, order sets, protocols, and drug quality specifications. The LabServiceDefinition profile constrains the resource PlanDefinition to represent a laboratory diagnostic service made visible to clinicians: the potential consumers of this service.LabServiceDefinition(xsd)(doc)=
<#base:PlanDefinition>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< An Extension; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< An absolute URI that is used to identify this plan definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this plan definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the plan definition is stored on different servers. Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.
The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](http://hl7.org/fhir/R5/resource.html#versions).
In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](http://hl7.org/fhir/R5/resource.html#meta) element to indicate where the current master source of the resource can be found.; (xsd)url:uri>?
[]< A formal identifier that is used to identify this plan definition when it is represented in other formats, or referenced in a specification, model, design or an instance. Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this plan definition outside of FHIR, where it is not possible to use the logical URI.; (xsd)identifier:Identifier>*
< The identifier that is used to identify this version of the plan definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the plan definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts. There may be different plan definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the plan definition with the format [url]|[version]. The version SHOULD NOT contain a '#' - see [Business Version](http://hl7.org/fhir/R5/resource.html#bv-format).; (xsd)version:string>?
< Indicates the mechanism used to compare versions to determine which is more current. If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined. Binding: version-algorithm (extensible, ); (xsd)versionAlgorithm:(<Coding>
|<string>)>?
< A natural language name identifying the plan definition. This name should be usable as an identifier for the module by machine processing applications such as code generation. The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.; (xsd)name:string>?
< A short, descriptive, user-friendly title for the plan definition. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.; (xsd)title:LabServiceDefinition.title>?
< An explanatory or alternate title for the plan definition giving additional information about its content.; (xsd)subtitle:string>?
< A high-level category for the plan definition that distinguishes the kinds of systems that would be interested in the plan definition. In this LabServiceDefiniton profile, PlanDefinition represents a laboratory service, which can be either a test or a panel.
A test is a single measurement performed on a material/digital specimen, producing generally one result (sometimes zero, sometime more).
A panel is a collection of tests and panels, performed on one or more material/digital specimens, and producing a collection of results.
Therefore, the type is bound to a value set {"test", "panel"}. The original value bound to this element with binding strength "extensible" does not contain appropriate values for laboratory diagnostic services. Binding: laboratory-service-type (extensible, ); (xsd)type:CodeableConcept>?
< The status of this plan definition. Enables tracking the life-cycle of the content. Allows filtering of plan definitions that are appropriate for use versus not.
See guidance around (not) making local changes to elements [here](http://hl7.org/fhir/R5/canonicalresource.html#localization). Binding: publication-status (required, The lifecycle status of an artifact.); (xsd)status:code>
< A Boolean value to indicate that this plan definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. Allows filtering of plan definitions that are appropriate for use versus not.; (xsd)experimental:boolean>?
< A code, group definition, or canonical reference that describes or identifies the intended subject of the plan definition. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource. Note that the choice of canonical for the subject element was introduced in R4B to support pharmaceutical quality use cases. To ensure as much backwards-compatibility as possible, it is recommended to only use the new canonical type with these use cases. Binding: participant-resource-types (extensible, The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).); (xsd)subject:(<AdministrableProductDefinition>
|<CodeableConcept>
|<EvidenceVariable>
|<Group>
|<ManufacturedItemDefinition>
|<MedicinalProductDefinition>
|<PackagedProductDefinition>
|<SubstanceDefinition>)>?
< The date (and optionally time) when the plan definition was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the plan definition changes. The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the plan definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
See guidance around (not) making local changes to elements [here](http://hl7.org/fhir/R5/canonicalresource.html#localization).; (xsd)date:dateTime>?
< The name of the organization or individual responsible for the release and ongoing maintenance of the plan definition. Usually an organization but may be an individual. The publisher (or steward) of the plan definition is the organization or individual primarily responsible for the maintenance and upkeep of the plan definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the plan definition. This item SHOULD be populated unless the information is available from context.; (xsd)publisher:string>?
[]< Contact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc.
See guidance around (not) making local changes to elements [here](http://hl7.org/fhir/R5/canonicalresource.html#localization).; (xsd)contact:ContactDetail>*
< A free text natural language description of the plan definition from a consumer's perspective. This description provides details such as when this laboratory diagnostic service can be ordered, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the plan definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the plan definition is presumed to be the predominant language in the place the plan definition was created).; (xsd)description:LabServiceDefinition.description>?
[]< The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate plan definition instances. When multiple useContexts are specified, in this LabServiceDefinition profile, all contexts apply to the defined laboratory service.; (xsd)useContext:UsageContext>*
[]< A legal or geographic region in which the plan definition is intended to be used. It may be possible for the plan definition to be used in jurisdictions other than those for which it was originally designed or intended.
DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.) Binding: jurisdiction (extensible, Countries and regions within which this artifact is targeted for use.); (xsd)jurisdiction:CodeableConcept>*
< Explanation of why this plan definition is needed and why it has been designed as it has. This element does not describe the usage of the plan definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this plan definition.; (xsd)purpose:markdown>?
< A detailed description of how the laboratory diagnostic service is used from a clinical perspective.; (xsd)usage:markdown>?
< A copyright statement relating to the plan definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the plan definition. The short copyright declaration (e.g. (c) '2015+ xyz organization' should be sent in the copyrightLabel element.; (xsd)copyright:markdown>?
< A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved'). The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.; (xsd)copyrightLabel:string>?
< The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.
See guidance around (not) making local changes to elements [here](http://hl7.org/fhir/R5/canonicalresource.html#localization).; (xsd)approvalDate:date>?
< The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. If specified, this date follows the original approval date.
See guidance around (not) making local changes to elements [here](http://hl7.org/fhir/R5/canonicalresource.html#localization).; (xsd)lastReviewDate:date>?
< The period during which the plan definition content was or is planned to be in active use. The effective period for a plan definition determines when the content is applicable for usage and is independent of publication and review dates. For example, a plan definition intended to be used for the year 2016 might be published in 2015.
See guidance around (not) making local changes to elements [here](http://hl7.org/fhir/R5/canonicalresource.html#localization).; (xsd)effectivePeriod:Period>?
[]< Descriptive topics related to the content of the laboratory service definition. Topics provide a high-level categorization of the definition that can be useful for filtering and searching. Some possible axes of categorization include laboratory specialty, kind of pathology, kind of biologic specimen tested, ... Topics are usually chosen by the laboratory or the organization owning the catalog Binding: definition-topic (example, High-level categorization of the definition, used for searching, sorting, and filtering.); (xsd)topic:CodeableConcept>*
[]< An individiual or organization primarily involved in the creation and maintenance of the content.; (xsd)author:ContactDetail>*
[]< An individual or organization primarily responsible for internal coherence of the content.; (xsd)editor:ContactDetail>*
[]< An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the content. See guidance around (not) making local changes to elements [here](http://hl7.org/fhir/R5/canonicalresource.html#localization).; (xsd)reviewer:ContactDetail>*
[]< An individual or organization asserted by the publisher to be responsible for officially endorsing the content for use in some setting. See guidance around (not) making local changes to elements [here](http://hl7.org/fhir/R5/canonicalresource.html#localization).; (xsd)endorser:ContactDetail>*
[]< Related artifacts such as additional documentation, justification, or bibliographic references. Each related artifact is either an attachment, or a reference to another resource, but not both.; (xsd)relatedArtifact:RelatedArtifact>*
[]< A reference to a Library resource containing any formal logic used by the plan definition.; (xsd)library:Library*>*
[]< A goal describes an expected outcome that activities within the plan are intended to achieve. For example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, meeting the acceptance criteria for a test as specified by a quality specification, etc.; (xsd)goal:LabServiceDefinition.goal>*
[]< Actors represent the individuals or groups involved in the execution of the defined set of activities.; (xsd)actor:LabServiceDefinition.actor>*
< The concrete action or group of actions conveyed by this laboratory diagnostic service The LabServiceDefinition profile constrains the content of PlanDefinition to be a single action at the top level. This action may be implemented by a single laboratory procedure referenced as an instance of ActivityDefinition, or may be decomposed into any level of logical groups of more granular actions, each leaf action referencing an ActivityDefinition.; (xsd)action:LabServiceDefinition.action>
< If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example "pain", "on flare-up", etc. Binding: medication-as-needed-reason (example, A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc.); (xsd)asNeeded:(<boolean>
|<CodeableConcept>)>?
[]< This extension to PlanDefinition, MedicationKnowledge and DeviceDefinition conveys the reference to a catalog containing the extended resource; (xsd)CatalogReference>*
[]< Optional Extension Element - found in all resources.; (xsd)ServiceBillingCode>*
< An Extension; (xsd)BillingSummary>?
< An Extension; (xsd)ScheduleSummary>?
< An Extension; (xsd)LimitationSummary>?
< An Extension; (xsd)RegulatorySummary>?
< An Extension; (xsd)ResultInterpretationSummary>?
< The presence of this slice indicates that the service is open to laboratory order entry When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.; (xsd)Orderable:LabServiceDefinition.Orderable>?
< The presence of this slice indicates that the service may be added to an existing order by the pathologist after review of the preliminary results of this order When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.; (xsd)PathologistInitiative:LabServiceDefinition.PathologistInitiative>?
< The presence of this slice indicates that the service is restricted to one gender of subject (female or male) When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.; (xsd)OneGender:LabServiceDefinition.OneGender>?
< The presence of this slice indicates that the specimens used to perform this service will be kept in long-time storage and available for re-testing in the future When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.; (xsd)StoreSpecimen:LabServiceDefinition.StoreSpecimen>?
[]< The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate plan definition instances. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.; (xsd)AgeRange:LabServiceDefinition.AgeRange>*
[]< Document that needs to be provided alongside the order for the laboratory service Examples of documents that should accompany an order for this service include patient consent for genetic testing, patient agreement for payment of a non-reimbursable service, insurance formal acceptation of a specific test (e.g. prenatal karyotyping) ...; (xsd)InputDocumentExpected:LabServiceDefinition.InputDocumentExpected>*
[]< The related artifact is another instance of PlanDefinition, which is a replacement for the current no longer usable laboratory service Each related artifact is either an attachment, or a reference to another resource, but not both.; (xsd)IsReplacedBy:LabServiceDefinition.IsReplacedBy>*
[]< The related artifact is another instance of PlanDefinition, representing a laboratory service orderable on its own, and which is also part of the current one, either systematically or reflexed by a trigger. Each related artifact is either an attachment, or a reference to another resource, but not both.; (xsd)Includes:LabServiceDefinition.Includes>*
[]< Related bibliographic references such as documentation, justification, or citation. Each related artifact is either an attachment, or a reference to another resource, but not both.; (xsd)Bibliography:LabServiceDefinition.Bibliography>*🔗 The concrete action or group of actions conveyed by this laboratory diagnostic service The LabServiceDefinition profile constrains the content of PlanDefinition to be a single action at the top level. This action may be implemented by a single laboratory procedure referenced as an instance of ActivityDefinition, or may be decomposed into any level of logical groups of more granular actions, each leaf action referencing an ActivityDefinition.LabServiceDefinition.action(xsd)(doc)=
<#base:PlanDefinition.action>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< An Extension; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< An identifier that is unique within the PlanDefinition to allow linkage within the realized CarePlan and/or RequestOrchestration.; (xsd)linkId:string>?
< A user-visible prefix for the action. For example a section or item numbering such as 1. or A.; (xsd)prefix:string>?
< The textual description of the action displayed to a user. For example, when the action is a test to be performed, the title would be the title of the test such as Assay by HPLC.; (xsd)title:string>?
< A brief description of the laboratory service, which may mention the analytical method(s) used by the laboratory; (xsd)description:markdown>?
< A text equivalent of the action to be performed. This provides a human-interpretable description of the action when the definition is consumed by a system that might not be capable of interpreting it dynamically.; (xsd)textEquivalent:markdown>?
< Indicates how quickly this diagnostic panel or test should be performed. Binding: request-priority (required, Identifies the level of importance to be assigned to actioning the request.); (xsd)priority:code>?
< A code that provides meaning to the laboratory service Binding: action-code (example, Provides examples of actions to be performed.); (xsd)code:LabServiceDefinition.action.code>?
[]< A description of why this action is necessary or appropriate. This is different than the clinical evidence documentation, it's an actual business description of the reason for performing the action. Binding: action-reason-code (example, Provides examples of reasons for actions to be performed.); (xsd)reason:CodeableConcept>*
[]< Didactic or other informational resources associated with the action that can be provided to the CDS recipient. Information resources can include inline text commentary and links to web resources.; (xsd)documentation:RelatedArtifact>*
[]< Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition. In pharmaceutical quality, a goal represents acceptance criteria (Goal) for a given action (Test), so the goalId would be the unique id of a defined goal element establishing the acceptance criteria for the action.; (xsd)goalId:id>*
< A code, group definition, or canonical reference that describes the intended subject of the action and its children, if any. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource. The subject of an action overrides the subject at a parent action or on the root of the PlanDefinition if specified.
In addition, because the subject needs to be resolved during realization, use of subjects in actions (or in the ActivityDefinition referenced by the action) resolves based on the set of subjects supplied in context and by type (i.e. the patient subject would resolve to a resource of type Patient). Binding: participant-resource-types (extensible, The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).); (xsd)subject:(<CodeableConcept>
|<Group>
|<Resource>)>?
[]< A description of when the action should be triggered. When multiple triggers are specified on an action, any triggering event invokes the action.; (xsd)trigger:TriggerDefinition>*
[]< An expression that describes applicability criteria or start/stop conditions for the action. When multiple conditions of the same kind are present, the effects are combined using AND semantics, so the overall condition is true only if all the conditions are true.; (xsd)condition:LabServiceDefinition.action.condition>*
[]< Defines input data requirements for the action.; (xsd)input:LabServiceDefinition.action.input>*
[]< Defines the outputs of the action, if any.; (xsd)output:LabServiceDefinition.action.output>*
[]< A relationship to another action such as "before" or "30-60 minutes after start of". When an action depends on multiple actions, the meaning is that all actions are dependencies, rather than that any of the actions are a dependency.; (xsd)relatedAction:LabServiceDefinition.action.relatedAction>*
< An optional value describing when the action should be performed. The intent of the timing element is to provide timing when the action should be performed. As a definitional resource, this timing is interpreted as part of an apply operation so that the timing of the result actions in a CarePlan or RequestOrchestration, for example, would be specified by evaluating the timing definition in the context of the apply and setting the resulting timing on the appropriate elements of the target resource. If the timing is an Age, the activity is expected to be performed when the subject is the given Age. When the timing is a Duration, the activity is expected to be performed within the specified duration from the apply. When the timing is a Range, it may be a range of Ages or Durations, providing a range for the expected timing of the resulting activity. When the timing is a Timing, it is establishing a schedule for the timing of the resulting activity.; (xsd)timing:(<Age>
|<Duration>
|<Range>
|<Timing>)>?
< Identifies the facility where the action will occur; e.g. home, hospital, specific clinic, etc. May reference a specific clinical location or may just identify a type of location.; (xsd)location:Location*>?
[]< Indicates who should participate in performing the action described.; (xsd)participant:LabServiceDefinition.action.participant>*
< The type of action to perform (create, update, remove). Binding: action-type (extensible, The type of action to be performed.); (xsd)type:CodeableConcept>?
< Defines the grouping behavior for the action and its children. Binding: action-grouping-behavior (required, Defines organization behavior of a group.) logical-group; (xsd)groupingBehavior:code>?
< Defines the selection behavior for the action and its children. Binding: action-selection-behavior (required, Defines selection behavior of a group.); (xsd)selectionBehavior:code>?
< Defines the required behavior for the action. Binding: action-required-behavior (required, Defines expectations around whether an action or action group is required.); (xsd)requiredBehavior:code>?
< Defines whether the action should usually be preselected. Binding: action-precheck-behavior (required, Defines selection frequency behavior for an action or group.); (xsd)precheckBehavior:code>?
< Defines whether the action can be selected multiple times. Binding: action-cardinality-behavior (required, Defines behavior for an action or a group for how many times that item may be repeated.); (xsd)cardinalityBehavior:code>?
< A reference to an ActivityDefinition that describes the laboratory procedure to be performed, or to a PlanDefinition representing a child laboratory service, either embedded or reflexed by the current one. The definition is present only when there is no grouping of sub-actions; (xsd)definition:LabProcedureDefinition*>?
< A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input. Note that when a referenced ActivityDefinition also defines a transform, the transform specified here generally takes precedence. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.; (xsd)transform:StructureMap*>?
[]< Customizations that should be applied to the statically defined resource. For example, if the dosage of a medication must be computed based on the patient's weight, a customization would be used to specify an expression that calculated the weight, and the path on the resource that would contain the result. Dynamic values are applied in the order in which they are defined in the PlanDefinition resource. Note that when dynamic values are also specified by a referenced ActivityDefinition, the dynamicValues from the ActivityDefinition are applied first, followed by the dynamicValues specified here. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.; (xsd)dynamicValue:LabServiceDefinition.action.dynamicValue>*
[]< Sub actions that are contained within the action. The behavior of this action determines the functionality of the sub-actions. For example, a selection behavior of at-most-one indicates that of the sub-actions, at most one may be chosen as part of realizing the action definition.; (xsd)action:PlanDefinition.action>*
[]< A set of specimens requested as input by this laboratory service. The set is organized as a collection of one or more alternative groups (exactly one group should be chosen at specimen collection time). Each group describes one or more specimens that must all be provided, in case this group is the one chosen. In case this element has multiple occurrence, all occurrences apply: Each set of specimen requirements represented by an occurrence of action.extension:SpecimenRequested must be fulfilled for the service described by the PlanDefinition instance.; (xsd)SpecimenRequested>*
[]< This trigger introduces a reflex laboratory procedure (test or panel) represended by the ActivityDefinition referenced by the action.definition. The trigger is expressed as a named event, and may also be refined with a data requirement and a condition.; (xsd)Reflex:LabServiceDefinition.action.Reflex>*🔗 A code that provides meaning to the laboratory service Binding: action-code (example, Provides examples of actions to be performed.)LabServiceDefinition.action.code(xsd)(doc)=
<#base:CodeableConcept>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< 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.; (xsd)coding:Coding>*
< 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.; (xsd)text:string>?
< 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.; (xsd)orderCodeLOINC:LabServiceDefinition.action.code.orderCodeLOINC>?🔗 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.LabServiceDefinition.action.code.orderCodeLOINC(xsd)(doc)=
<#base:Coding>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< 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 be an absolute reference to some definition that establishes the system clearly and unambiguously. http://loinc.org; (xsd)system:uri>?
< 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.; (xsd)version:string>?
< 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).; (xsd)code>?
< A representation of the meaning of the code in the system, following the rules of the system.; (xsd)display:string>?
< 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.; (xsd)userSelected:boolean>?🔗 An expression that describes applicability criteria or start/stop conditions for the action. When multiple conditions of the same kind are present, the effects are combined using AND semantics, so the overall condition is true only if all the conditions are true.LabServiceDefinition.action.condition(xsd)(doc)=
<#base:PlanDefinition.action.condition>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The kind of condition. Applicability criteria are used to determine immediate applicability when a plan definition is applied to a given context. Start and stop criteria are carried through application and used to describe enter/exit criteria for an action. Binding: action-condition-kind (required, Defines the kinds of conditions that can appear on actions.); (xsd)kind:code>
< An expression that returns true or false, indicating whether the condition is satisfied. The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.; (xsd)expression:Expression>?🔗 Customizations that should be applied to the statically defined resource. For example, if the dosage of a medication must be computed based on the patient's weight, a customization would be used to specify an expression that calculated the weight, and the path on the resource that would contain the result. Dynamic values are applied in the order in which they are defined in the PlanDefinition resource. Note that when dynamic values are also specified by a referenced ActivityDefinition, the dynamicValues from the ActivityDefinition are applied first, followed by the dynamicValues specified here. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.LabServiceDefinition.action.dynamicValue(xsd)(doc)=
<#base:PlanDefinition.action.dynamicValue>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The path to the element to be customized. This is the path on the resource that will hold the result of the calculation defined by the expression. The specified path SHALL be a FHIRPath resolvable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. 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](http://hl7.org/fhir/R5/fhirpath.html#simple) for full details). To specify the path to the current action being realized, the %action environment variable is available in this path. For example, to specify the description element of the target action, the path would be %action.description. The path attribute contains a [Simple FHIRPath Subset](http://hl7.org/fhir/R5/fhirpath.html#simple) that allows path traversal, but not calculation.; (xsd)path:string>?
< An expression specifying the value of the customized element. The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.; (xsd)expression:Expression>?🔗 Defines input data requirements for the action.LabServiceDefinition.action.input(xsd)(doc)=
<#base:PlanDefinition.action.input>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A human-readable label for the data requirement used to label data flows in BPMN or similar diagrams. Also provides a human readable label when rendering the data requirement that conveys its purpose to human readers.; (xsd)title:string>?
< Defines the data that is to be provided as input to the action.; (xsd)requirement:DataRequirement>?
< Points to an existing input or output element that provides data to this input. The relatedData element allows indicating that an input to a parent action is an input to specific child actions. It also allows the output of one action to be identified as the input to a different action; (xsd)relatedData:id>?🔗 Defines the outputs of the action, if any.LabServiceDefinition.action.output(xsd)(doc)=
<#base:PlanDefinition.action.output>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A human-readable label for the data requirement used to label data flows in BPMN or similar diagrams. Also provides a human readable label when rendering the data requirement that conveys its purpose to human readers.; (xsd)title:string>?
< Defines the data that results as output from the action.; (xsd)requirement:DataRequirement>?
< Points to an existing input or output element that is results as output from the action. The relatedData element allows indicating that the output of child action is also the output of a parent action. It also allows the input of one action to be identified as the output of a different action; (xsd)relatedData:string>?🔗 Indicates who should participate in performing the action described.LabServiceDefinition.action.participant(xsd)(doc)=
<#base:PlanDefinition.action.participant>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A reference to the id element of the actor who will participate in this action.; (xsd)actorId:string>?
< The type of participant in the action. Binding: action-participant-type (required, The type of participant in the activity.); (xsd)type:code>?
< The type of participant in the action.; (xsd)typeCanonical:CapabilityStatement*>?
< The type of participant in the action. When this element is a reference, it SHOULD be a reference to a definitional resource (for example, a location type, rather than a specific location).; (xsd)typeReference:(<CareTeam>
|<Device>
|<DeviceDefinition>
|<Endpoint>
|<Group>
|<HealthcareService>
|<Location>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>?
< The role the participant should play in performing the described action. Binding: http://terminology.hl7.org/ValueSet/action-participant-role (example, Defines roles played by participants for the action.); (xsd)role:CodeableConcept>?
< Indicates how the actor will be involved in the action - author, reviewer, witness, etc. Binding: action-participant-function (example, ); (xsd)function:CodeableConcept>?🔗 This trigger introduces a reflex laboratory procedure (test or panel) represended by the ActivityDefinition referenced by the action.definition. The trigger is expressed as a named event, and may also be refined with a data requirement and a condition.LabServiceDefinition.action.Reflex(xsd)(doc)=
<#base:TriggerDefinition>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< The type of triggering event. Binding: trigger-type (required, The type of trigger.) named-event; (xsd)type:code>
< The natural language expression of the trigger for the reflex laboratory procedure 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.; (xsd)name:string>
< A code that identifies the event.; (xsd)code:CodeableConcept>?
< A reference to a SubscriptionTopic resource that defines the event. If this element is provided, no other information about the trigger definition may be supplied.; (xsd)subscriptionTopic:SubscriptionTopic*>?
< The timing of the event (if this is a periodic trigger).; (xsd)timing:(<date>
|<dateTime>
|<Schedule>
|<Timing>)>?
[]< 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.; (xsd)data:DataRequirement>*
< 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.; (xsd)condition:Expression>?🔗 A relationship to another action such as "before" or "30-60 minutes after start of". When an action depends on multiple actions, the meaning is that all actions are dependencies, rather than that any of the actions are a dependency.LabServiceDefinition.action.relatedAction(xsd)(doc)=
<#base:PlanDefinition.action.relatedAction>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The element id of the target related action.; (xsd)targetId:id>
< The relationship of the start of this action to the related action. Binding: action-relationship-type (required, Defines the types of relationships between actions.); (xsd)relationship:code>
< The relationship of the end of this action to the related action. Binding: action-relationship-type (required, Defines the types of relationships between actions.); (xsd)endRelationship:code>?
< A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.; (xsd)offset:(<Duration>
|<Range>)>?🔗 Actors represent the individuals or groups involved in the execution of the defined set of activities.LabServiceDefinition.actor(xsd)(doc)=
<#base:PlanDefinition.actor>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A descriptive label for the actor.; (xsd)title:string>?
< A description of how the actor fits into the overall actions of the plan definition.; (xsd)description:markdown>?
[]< The characteristics of the candidates that could serve as the actor.; (xsd)option:LabServiceDefinition.actor.option>+🔗 The characteristics of the candidates that could serve as the actor.LabServiceDefinition.actor.option(xsd)(doc)=
<#base:PlanDefinition.actor.option>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The type of participant in the action. Binding: action-participant-type (required, The type of participant in the activity.); (xsd)type:code>?
< The type of participant in the action.; (xsd)typeCanonical:CapabilityStatement*>?
< The type of participant in the action. When this element is a reference, it SHOULD be a reference to a definitional resource (for example, a location type, rather than a specific location).; (xsd)typeReference:(<CareTeam>
|<Device>
|<DeviceDefinition>
|<Endpoint>
|<Group>
|<HealthcareService>
|<Location>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>?
< The role the participant should play in performing the described action. Binding: http://terminology.hl7.org/ValueSet/action-participant-role (example, ); (xsd)role:CodeableConcept>?🔗 The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate plan definition instances. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.LabServiceDefinition.AgeRange(xsd)(doc)=
<#base:UsageContext>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< A code that identifies the type of context being specified by this usage context. Binding: http://terminology.hl7.org/ValueSet/usage-context-type (extensible, A code that specifies a type of context being specified by a usage context.); (xsd)code:Coding>
< A value that defines the context specified in this context of use. The interpretation of the value is defined by the code. Binding: use-context (example, A code that defines the specific value for the context being specified.); (xsd)value:Range>🔗 Related bibliographic references such as documentation, justification, or citation. Each related artifact is either an attachment, or a reference to another resource, but not both.LabServiceDefinition.Bibliography(xsd)(doc)=
<#base:RelatedArtifact>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< kind of associated bibliographic artifact The presence of both sides of a relationship type (e.g. successor and predecessor) is required to support use cases where one side of a relationship is not represented in FHIR. However, this feature SHALL NOT be used to create bi-directional resource links in FHIR instances. Specifically, following the methodology of "new points to old" and "many points to one", when using related artifact elements to describe and reference FHIR resources, the type element SHALL be drawn from the fhir-related-artifact-type ValueSet. Binding: bibliography-artifact-type (required, ); (xsd)type:code>
[]< Provides additional classifiers of the related artifact. Binding: citation-artifact-classifier (example, Additional classifiers for the related artifact.); (xsd)classifier:CodeableConcept>*
< A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index.; (xsd)label:string>?
< A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.; (xsd)display:string>?
< 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.; (xsd)citation:markdown>?
< The document being referenced, represented as an attachment. This is exclusive with the resource element.; (xsd)document:Attachment>?
< The related artifact, 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.; (xsd)resource:Resource*>?
< The related artifact, if the artifact is not a canonical resource, or a resource reference to a canonical resource. If both resource and resourceReference are present, they SHOULD be consistent and reference the same resource. Although relatedArtifact is intended to support references to definitional resources, there are cases where non-definitional resources can be definitional (such as Location where the kind is mode). Related artifacts SHOULD be used to reference definitional resources, and profiles SHOULD be used to make that explicit for particular use cases.; (xsd)resourceReference:Resource*>?
< The publication status of the artifact being referred to. Binding: publication-status (required, Publication status of an artifact being referred to.); (xsd)publicationStatus:code>?
< The date of publication of the artifact being referred to.; (xsd)publicationDate:date>?🔗 A free text natural language description of the plan definition from a consumer's perspective. This description provides details such as when this laboratory diagnostic service can be ordered, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the plan definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the plan definition is presumed to be the predominant language in the place the plan definition was created).LabServiceDefinition.description(xsd)(doc)=
<#base:markdown>
< unique id for the element within a resource (for internal references); (xsd)id:string>?
[]< An Extension; (xsd)extension:Extension>*
< Primitive value for markdown; (xsd)value:string>?
[]< Translation of the description of the laboratory service in a specified language; (xsd)OtherDescription:Extension>*🔗 A goal describes an expected outcome that activities within the plan are intended to achieve. For example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, meeting the acceptance criteria for a test as specified by a quality specification, etc.LabServiceDefinition.goal(xsd)(doc)=
<#base:PlanDefinition.goal>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Indicates a category the goal falls within. Binding: goal-category (example, Example codes for grouping goals for filtering or presentation.); (xsd)category:CodeableConcept>?
< Human-readable and/or coded description of a specific desired objective of care, such as "control blood pressure" or "negotiate an obstacle course" or "dance with child at wedding". If no code is available, use CodeableConcept.text. Binding: clinical-findings (example, Describes goals that can be achieved.); (xsd)description:CodeableConcept>
< Identifies the expected level of importance associated with reaching/sustaining the defined goal. Binding: goal-priority (preferred, Indicates the level of importance associated with reaching or sustaining a goal.); (xsd)priority:CodeableConcept>?
< The event after which the goal should begin being pursued. Binding: goal-start-event (example, Identifies the types of events that might trigger the start of a goal.); (xsd)start:CodeableConcept>?
[]< Identifies problems, conditions, issues, or concerns the goal is intended to address. Binding: condition-code (example, Identifies problems, conditions, issues, or concerns that goals may address.); (xsd)addresses:CodeableConcept>*
[]< Didactic or other informational resources associated with the goal that provide further supporting information about the goal. Information resources can include inline text commentary and links to web resources.; (xsd)documentation:RelatedArtifact>*
[]< Indicates what should be done and within what timeframe.; (xsd)target:LabServiceDefinition.goal.target>*🔗 Indicates what should be done and within what timeframe.LabServiceDefinition.goal.target(xsd)(doc)=
<#base:PlanDefinition.goal.target>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The parameter whose value is to be tracked, e.g. body weight, blood pressure, or hemoglobin A1c level. Binding: observation-codes (example, Identifies types of parameters that can be tracked to determine goal achievement.); (xsd)measure:CodeableConcept>?
< The target value of the measure to be achieved to signify fulfillment of the goal, e.g. 150 pounds or 7.0%, or in the case of pharmaceutical quality - NMT 0.6%, Clear solution, etc. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any value at or above the low value. A CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the goal.target.measure defines a coded value.; (xsd)detail:(<boolean>
|<CodeableConcept>
|<integer>
|<Quantity>
|<Range>
|<Ratio>
|<string>)>?
< Indicates the timeframe after the start of the goal in which the goal should be met.; (xsd)due:Duration>?🔗 The related artifact is another instance of PlanDefinition, representing a laboratory service orderable on its own, and which is also part of the current one, either systematically or reflexed by a trigger. Each related artifact is either an attachment, or a reference to another resource, but not both.LabServiceDefinition.Includes(xsd)(doc)=
<#base:RelatedArtifact>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< The type of relationship to the related artifact is composed-of, meaning that the related artifact is another standalone laboratory service, which is also included as a sub-service of the current one. The presence of both sides of a relationship type (e.g. successor and predecessor) is required to support use cases where one side of a relationship is not represented in FHIR. However, this feature SHALL NOT be used to create bi-directional resource links in FHIR instances. Specifically, following the methodology of "new points to old" and "many points to one", when using related artifact elements to describe and reference FHIR resources, the type element SHALL be drawn from the fhir-related-artifact-type ValueSet. Binding: related-artifact-type (required, The type of relationship to the related artifact.) composed-of; (xsd)type:code>
[]< Provides additional classifiers of the related artifact. Binding: citation-artifact-classifier (example, Additional classifiers for the related artifact.); (xsd)classifier:CodeableConcept>*
< A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index.; (xsd)label:string>?
< A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.; (xsd)display:string>?
< 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.; (xsd)citation:markdown>?
< The document being referenced, represented as an attachment. This is exclusive with the resource element.; (xsd)document:Attachment>?
< The related resource, in this case a PlanDefinition constrained by the LabServiceDefinition profile 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.; (xsd)resource:LabServiceDefinition*>
< The related artifact, if the artifact is not a canonical resource, or a resource reference to a canonical resource. If both resource and resourceReference are present, they SHOULD be consistent and reference the same resource. Although relatedArtifact is intended to support references to definitional resources, there are cases where non-definitional resources can be definitional (such as Location where the kind is mode). Related artifacts SHOULD be used to reference definitional resources, and profiles SHOULD be used to make that explicit for particular use cases.; (xsd)resourceReference:Resource*>?
< The publication status of the artifact being referred to. Binding: publication-status (required, Publication status of an artifact being referred to.); (xsd)publicationStatus:code>?
< The date of publication of the artifact being referred to.; (xsd)publicationDate:date>?🔗 Document that needs to be provided alongside the order for the laboratory service Examples of documents that should accompany an order for this service include patient consent for genetic testing, patient agreement for payment of a non-reimbursable service, insurance formal acceptation of a specific test (e.g. prenatal karyotyping) ...LabServiceDefinition.InputDocumentExpected(xsd)(doc)=
<#base:RelatedArtifact>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< The type of relationship to the related artifact. The presence of both sides of a relationship type (e.g. successor and predecessor) is required to support use cases where one side of a relationship is not represented in FHIR. However, this feature SHALL NOT be used to create bi-directional resource links in FHIR instances. Specifically, following the methodology of "new points to old" and "many points to one", when using related artifact elements to describe and reference FHIR resources, the type element SHALL be drawn from the fhir-related-artifact-type ValueSet. Binding: related-artifact-type (required, The type of relationship to the related artifact.) depends-on; (xsd)type:code>
[]< Provides additional classifiers of the related artifact. Binding: citation-artifact-classifier (example, Additional classifiers for the related artifact.); (xsd)classifier:CodeableConcept>*
< Various kinds (or models) of documents may be expected as input to a laboratory service. This element provides an unambiguous short name for such a kind of document. Examples of kinds of documents expected include:
- the paper lab order scanned
- the statement of acceptation of the service by the insurance provider (e.g. for a prenatal karyotyping)
- the patient consent (e.g. for a genetic test)
- the patient insurance affiliation scanned; (xsd)label:string>
< A brief description of the document that need to be provided alongside the order of this laboratory service; (xsd)display:string>
< 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.; (xsd)citation:markdown>?
< provides in the attachment a model for the kind of document expected The model can be encoded in base64 in the data sub-element, with its mime type encoded in the contentType sub-element, or it can be external, accessible through the url sub-element.; (xsd)document:LabServiceDefinition.InputDocumentExpected.document>?
< The related artifact, 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.; (xsd)resource:Resource*>?
< The related artifact, if the artifact is not a canonical resource, or a resource reference to a canonical resource. If both resource and resourceReference are present, they SHOULD be consistent and reference the same resource. Although relatedArtifact is intended to support references to definitional resources, there are cases where non-definitional resources can be definitional (such as Location where the kind is mode). Related artifacts SHOULD be used to reference definitional resources, and profiles SHOULD be used to make that explicit for particular use cases.; (xsd)resourceReference:Resource*>?
< The publication status of the artifact being referred to. Binding: publication-status (required, Publication status of an artifact being referred to.); (xsd)publicationStatus:code>?
< The date of publication of the artifact being referred to.; (xsd)publicationDate:date>?🔗 provides in the attachment a model for the kind of document expected The model can be encoded in base64 in the data sub-element, with its mime type encoded in the contentType sub-element, or it can be external, accessible through the url sub-element.LabServiceDefinition.InputDocumentExpected.document(xsd)(doc)=
<#base:Attachment>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< 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. Binding: mimetypes (required, BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)); (xsd)contentType:code>?
< The human language of the content. The value can be any valid value according to BCP 47. Binding: all-languages (required, IETF language tag for a human language.); (xsd)language:code>?
< 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.; (xsd)data:base64Binary>?
< used if the model of document is accessible externally 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.; (xsd)url>?
< 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.; (xsd)size:integer64>?
< 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](http://hl7.org/fhir/R5/provenance-definitions.html#Provenance.signature) for mechanism to protect a resource with a digital signature.; (xsd)hash:base64Binary>?
< May be sufficient to specify the document expected, in cases where no pre-defined needs to be communicated to the orderer of the service. May sometimes be derived from the source filename.; (xsd)title:string>?
< The date that the attachment was first created.; (xsd)creation:dateTime>?
< Height of the image in pixels (photo/video).; (xsd)height:positiveInt>?
< Width of the image in pixels (photo/video).; (xsd)width:positiveInt>?
< The number of frames in a photo. This is used with a multi-page fax, or an imaging acquisition context that takes multiple slices in a single image, or an animated gif. If there is more than one frame, this SHALL have a value in order to alert interface software that a multi-frame capable rendering widget is required. if the number of frames is not supplied, the value may be unknown. Applications should not assume that there is only one frame unless it is explicitly stated.; (xsd)frames:positiveInt>?
< The duration of the recording in seconds - for audio and video. The duration might differ from occurrencePeriod if recording was paused.; (xsd)duration:decimal>?
< The number of pages when printed.; (xsd)pages:positiveInt>?🔗 The related artifact is another instance of PlanDefinition, which is a replacement for the current no longer usable laboratory service Each related artifact is either an attachment, or a reference to another resource, but not both.LabServiceDefinition.IsReplacedBy(xsd)(doc)=
<#base:RelatedArtifact>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< The type of relationship to the related artifact is successor, meaning that the related artifact is in this case another instance of PlanDefinition representing the laboratory service, which is substituted to the current instance. The presence of both sides of a relationship type (e.g. successor and predecessor) is required to support use cases where one side of a relationship is not represented in FHIR. However, this feature SHALL NOT be used to create bi-directional resource links in FHIR instances. Specifically, following the methodology of "new points to old" and "many points to one", when using related artifact elements to describe and reference FHIR resources, the type element SHALL be drawn from the fhir-related-artifact-type ValueSet. Binding: related-artifact-type (required, The type of relationship to the related artifact.) successor; (xsd)type:code>
[]< Provides additional classifiers of the related artifact. Binding: citation-artifact-classifier (example, Additional classifiers for the related artifact.); (xsd)classifier:CodeableConcept>*
< A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index.; (xsd)label:string>?
< A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.; (xsd)display:string>?
< 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.; (xsd)citation:markdown>?
< The document being referenced, represented as an attachment. This is exclusive with the resource element.; (xsd)document:Attachment>?
< The related resource, in this case a PlanDefinition constrained by the LabServiceDefinition profile 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.; (xsd)resource:LabServiceDefinition*>
< The related artifact, if the artifact is not a canonical resource, or a resource reference to a canonical resource. If both resource and resourceReference are present, they SHOULD be consistent and reference the same resource. Although relatedArtifact is intended to support references to definitional resources, there are cases where non-definitional resources can be definitional (such as Location where the kind is mode). Related artifacts SHOULD be used to reference definitional resources, and profiles SHOULD be used to make that explicit for particular use cases.; (xsd)resourceReference:Resource*>?
< The publication status of the artifact being referred to. Binding: publication-status (required, Publication status of an artifact being referred to.); (xsd)publicationStatus:code>?
< The date of publication of the artifact being referred to.; (xsd)publicationDate:date>?🔗 The presence of this slice indicates that the service is restricted to one gender of subject (female or male) When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.LabServiceDefinition.OneGender(xsd)(doc)=
<#base:UsageContext>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< A code that identifies the type of context being specified by this usage context. Binding: http://terminology.hl7.org/ValueSet/usage-context-type (extensible, A code that specifies a type of context being specified by a usage context.); (xsd)code:Coding>
< A value that defines the context specified in this context of use. The interpretation of the value is defined by the code. Binding: administrative-gender (required, ); (xsd)value:CodeableConcept>🔗 The presence of this slice indicates that the service is open to laboratory order entry When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.LabServiceDefinition.Orderable(xsd)(doc)=
<#base:UsageContext>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< A code that identifies the type of context being specified by this usage context. Binding: http://terminology.hl7.org/ValueSet/usage-context-type (extensible, A code that specifies a type of context being specified by a usage context.); (xsd)code:Coding>
< A value that defines the context specified in this context of use. The interpretation of the value is defined by the code. Binding: use-context (example, A code that defines the specific value for the context being specified.); (xsd)value:CodeableConcept>🔗 The presence of this slice indicates that the service may be added to an existing order by the pathologist after review of the preliminary results of this order When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.LabServiceDefinition.PathologistInitiative(xsd)(doc)=
<#base:UsageContext>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< A code that identifies the type of context being specified by this usage context. Binding: http://terminology.hl7.org/ValueSet/usage-context-type (extensible, A code that specifies a type of context being specified by a usage context.); (xsd)code:Coding>
< A value that defines the context specified in this context of use. The interpretation of the value is defined by the code. Binding: use-context (example, A code that defines the specific value for the context being specified.); (xsd)value:CodeableConcept>🔗 The presence of this slice indicates that the specimens used to perform this service will be kept in long-time storage and available for re-testing in the future When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.LabServiceDefinition.StoreSpecimen(xsd)(doc)=
<#base:UsageContext>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< A code that identifies the type of context being specified by this usage context. Binding: http://terminology.hl7.org/ValueSet/usage-context-type (extensible, A code that specifies a type of context being specified by a usage context.); (xsd)code:Coding>
< A value that defines the context specified in this context of use. The interpretation of the value is defined by the code. Binding: use-context (example, A code that defines the specific value for the context being specified.); (xsd)value:CodeableConcept>🔗 A short, descriptive, user-friendly title for the plan definition. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.LabServiceDefinition.title(xsd)(doc)=
<#base:string>
< unique id for the element within a resource (for internal references); (xsd)id:string>?
[]< An Extension; (xsd)extension:Extension>*
< The actual value; (xsd)value:string>?
[]< Expresses a synonym of the laboratory service in a specified language; (xsd)OtherTitle:Extension>*🔗 A kind of specimen with associated set of requirements.LabSpecimenDefinition(xsd)(doc)=
<#base:SpecimenDefinition>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< An absolute URL that is used to identify this SpecimenDefinition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this SpecimenDefinition is (or will be) published. The URL SHOULD include the major version of the SpecimenDefinition. For more information see Technical and Business Versions. Can be a urn:uuid: or a urn:oid:, but real http: addresses are preferred. This is the URI that will be used when making canonical references to this resource.; (xsd)url:uri>?
< A business identifier assigned to this SpecimenDefinition.; (xsd)identifier:Identifier>?
< The identifier that is used to identify this version of the SpecimenDefinition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the SpecimenDefinition author and is not expected to be globally unique. There may be multiple different instances of a SpecimenDefinition that have the same identifier but different versions.; (xsd)version:string>?
< Indicates the mechanism used to compare versions to determine which is more current. If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined. Binding: version-algorithm (extensible, ); (xsd)versionAlgorithm:(<Coding>
|<string>)>?
< A natural language name identifying the {{title}}. This name should be usable as an identifier for the module by machine processing applications such as code generation. The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.; (xsd)name:string>?
< A short, descriptive, user-friendly title for the SpecimenDefinition.; (xsd)title:string>?
[]< The canonical URL pointing to another FHIR-defined SpecimenDefinition that is adhered to in whole or in part by this definition.; (xsd)derivedFromCanonical:SpecimenDefinition*>*
[]< The URL pointing to an externally-defined type of specimen, guideline or other definition that is adhered to in whole or in part by this definition.; (xsd)derivedFromUri:uri>*
< The current state of theSpecimenDefinition. A nominal state-transition diagram can be found in the [Definition pattern](http://hl7.org/fhir/R5/definition.html#statemachine) documentation
Unknown does not represent "other" - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is.
See guidance around (not) making local changes to elements [here](http://hl7.org/fhir/R5/canonicalresource.html#localization). Binding: publication-status (required, Codes identifying the status of a SpecimenDefinition resource.); (xsd)status:code>
< A flag to indicate that this SpecimenDefinition is not authored for genuine usage. Allows filtering of SpecimenDefinition that are appropriate for use vs. not.; (xsd)experimental:boolean>?
< A code or group definition that describes the intended subject from which this kind of specimen is to be collected. Examples: person, animal, device, water ….; (xsd)subject:(<CodeableConcept>
|<Group>)>?
< For draft definitions, indicates the date of initial creation. For active definitions, represents the date of activation. For withdrawn definitions, indicates the date of withdrawal. See guidance around (not) making local changes to elements [here](http://hl7.org/fhir/R5/canonicalresource.html#localization).; (xsd)date:dateTime>?
< Helps establish the "authority/credibility" of the SpecimenDefinition. May also allow for contact.; (xsd)publisher:string>?
[]< Contact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc.
See guidance around (not) making local changes to elements [here](http://hl7.org/fhir/R5/canonicalresource.html#localization).; (xsd)contact:ContactDetail>*
< A free text natural language description of the SpecimenDefinition from the consumer's perspective. This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the module as conveyed in the text field of the resource itself. This item SHOULD be populated unless the information is available from context.; (xsd)description:markdown>?
[]< The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of specimen definitions. When multiple usageContexts are specified, there is no expectation for whether all or any of the contexts apply.; (xsd)useContext:UsageContext>*
[]< A jurisdiction in which the SpecimenDefinition is intended to be used. DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.) Binding: jurisdiction (extensible, Codes for country, country subdivision and region for indicating where a resource is intended to be used.); (xsd)jurisdiction:CodeableConcept>*
< Explains why this SpecimeDefinition is needed and why it has been designed as it has. This element does not describe the usage of the SpecimenDefinition. Rather it is for traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this SpecimenDefinition.; (xsd)purpose:markdown>?
< Copyright statement relating to the SpecimenDefinition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the SpecimenDefinition.; (xsd)copyright:markdown>?
< A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved'). The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.; (xsd)copyrightLabel:string>?
< The date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usage. The date may be more recent than the approval date because of minor changes / editorial corrections.
See guidance around (not) making local changes to elements [here](http://hl7.org/fhir/R5/canonicalresource.html#localization).; (xsd)approvalDate:date>?
< The date on which the asset content was last reviewed. Review happens periodically after that, but doesn't change the original approval date. If specified, this is usually after the approval date.
See guidance around (not) making local changes to elements [here](http://hl7.org/fhir/R5/canonicalresource.html#localization).; (xsd)lastReviewDate:date>?
< The period during which the SpecimenDefinition content was or is planned to be effective. The effective period for a SpecimenDefinition determines when the content is applicable for usage and is independent of publication and review dates.
See guidance around (not) making local changes to elements [here](http://hl7.org/fhir/R5/canonicalresource.html#localization).; (xsd)effectivePeriod:Period>?
< The kind of material to be collected. Binding: http://terminology.hl7.org/ValueSet/v2-0487 (example, The type of the specimen to be collected.); (xsd)typeCollected:CodeableConcept>?
[]< Preparation of the patient for specimen collection. Binding: prepare-patient-prior-specimen-collection (example, SCT descendants of 703763000 |Precondition value (qualifier value)|); (xsd)patientPreparation:CodeableConcept>*
< Time aspect of specimen collection (duration or offset).; (xsd)timeAspect:string>?
[]< The action to be performed for collecting the specimen. Binding: specimen-collection (example, SCT actions and procedures for specimen collection); (xsd)collection:CodeableConcept>*
[]< Specimen conditioned in a container as expected by the testing laboratory.; (xsd)typeTested:LabSpecimenDefinition.typeTested>*🔗 Specimen conditioned in a container as expected by the testing laboratory.LabSpecimenDefinition.typeTested(xsd)(doc)=
<#base:SpecimenDefinition.typeTested>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Primary of secondary specimen.; (xsd)isDerived:boolean>?
< The kind of specimen conditioned for testing expected by lab. Binding: http://terminology.hl7.org/ValueSet/v2-0487 (example, The type of specimen conditioned in a container for lab testing.); (xsd)type:CodeableConcept>?
< The preference for this type of conditioned specimen. Binding: specimen-contained-preference (required, Degree of preference of a type of conditioned specimen.); (xsd)preference:code>
< The specimen's container.; (xsd)container:LabSpecimenDefinition.typeTested.container>?
< Requirements for delivery and special handling of this kind of conditioned specimen.; (xsd)requirement:markdown>?
< The usual time that a specimen of this kind is retained after the ordered tests are completed, for the purpose of additional testing.; (xsd)retentionTime:Duration>?
< Specimen can be used by only one test or panel if the value is "true".; (xsd)singleUse:boolean>?
[]< Criterion for rejection of the specimen in its container by the laboratory. Binding: rejection-criteria (example, Criterion for rejection of the specimen by laboratory.); (xsd)rejectionCriterion:CodeableConcept>*
[]< Set of instructions for preservation/transport of the specimen at a defined temperature interval, prior the testing process.; (xsd)handling:LabSpecimenDefinition.typeTested.handling>*
[]< Where the specimen will be tested: e.g., lab, sector, device or any combination of these. Binding: diagnostic-service-sections (example, Codes specifying where the specimen will be tested.); (xsd)testingDestination:CodeableConcept>*🔗 The specimen's container.LabSpecimenDefinition.typeTested.container(xsd)(doc)=
<#base:SpecimenDefinition.typeTested.container>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The type of material of the container. Examples: glass, plastic, metal. Binding: container-material (example, SCT 32039001 |Glass|, 61088005 |Plastic|, 425620007 |Metal|); (xsd)material:CodeableConcept>?
< The type of container used to contain this kind of specimen. Binding: specimen-container-type (example, SCT descendants of 706041008 |Device for body fluid and tissue collection/transfer/processing (physical object)|); (xsd)type:CodeableConcept>?
< Color of container cap. Binding: container-cap (example, Color of the container cap.); (xsd)cap:CodeableConcept>?
< The textual description of the kind of container.; (xsd)description:markdown>?
< The capacity (volume or other measure) of this kind of container.; (xsd)capacity:SimpleQuantity>?
< The minimum volume to be conditioned in the container.; (xsd)minimumVolume:(<SimpleQuantity>
|<string>)>?
[]< Substance introduced in the kind of container to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA.; (xsd)additive:LabSpecimenDefinition.typeTested.container.additive>*
< Special processing that should be applied to the container for this kind of specimen.; (xsd)preparation:markdown>?🔗 Substance introduced in the kind of container to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA.LabSpecimenDefinition.typeTested.container.additive(xsd)(doc)=
<#base:SpecimenDefinition.typeTested.container.additive>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Substance introduced in the kind of container to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA. Binding: http://terminology.hl7.org/ValueSet/v2-0371 (example, Substance added to specimen container.); (xsd)additive:(<CodeableConcept>
|<SubstanceDefinition>)>🔗 Set of instructions for preservation/transport of the specimen at a defined temperature interval, prior the testing process.LabSpecimenDefinition.typeTested.handling(xsd)(doc)=
<#base:SpecimenDefinition.typeTested.handling>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< It qualifies the interval of temperature, which characterizes an occurrence of handling. Conditions that are not related to temperature may be handled in the instruction element. Binding: handling-condition (example, Set of handling instructions prior testing of the specimen.); (xsd)temperatureQualifier:CodeableConcept>?
< The temperature interval for this set of handling instructions.; (xsd)temperatureRange:Range>?
< The maximum time interval of preservation of the specimen with these conditions.; (xsd)maxDuration:Duration>?
< Additional textual instructions for the preservation or transport of the specimen. For instance, 'Protect from light exposure'.; (xsd)instruction:markdown>?🔗 Group of elements for LDL Cholesterol result. Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as laboratory reports, etc.ldlcholesterol(xsd)(doc)=
<#base:Observation>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< A unique identifier assigned to this observation.; (xsd)identifier:Identifier>*
< The reference to a FHIR ObservationDefinition resource that provides the definition that is adhered to in whole or in part by this Observation instance. ObservationDefinition can be referenced by its canonical url using instantiatesCanonical, or by a name or an identifier using the appropriate sub-elements of instantiatesReference.; (xsd)instantiates:ObservationDefinition*>?
[]< A plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed.; (xsd)basedOn:(<CarePlan>
|<DeviceRequest>
|<ImmunizationRecommendation>
|<MedicationRequest>
|<NutritionOrder>
|<ServiceRequest>)>*
[]< Identifies the observation(s) that triggered the performance of this observation.; (xsd)triggeredBy:ldlcholesterol.triggeredBy>*
[]< A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure. To link an Observation to an Encounter use `encounter`. See the [Notes](observation.html#obsgrouping) below for guidance on referencing another Observation.; (xsd)partOf:(<GenomicStudy>
|<ImagingStudy>
|<Immunization>
|<MedicationAdministration>
|<MedicationDispense>
|<MedicationStatement>
|<Procedure>)>*
< The status of the result value. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. Binding: observation-status (required, Codes providing the status of an observation.); (xsd)status:code>
[]< A code that classifies the general type of observation being made. In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set. Binding: observation-category (preferred, Codes for high level observation categories.); (xsd)category:CodeableConcept>*
< LDL Cholesterol -measured or calculated per code. *All* code-value and, if present, component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. Binding: lipid-ldl-codes (required, LDL Cholesterol codes - measured or calculated.); (xsd)code:CodeableConcept>
< The patient, or group of patients, location, device, organization, procedure or practitioner this observation is about and into whose or what record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the `focus` element or the `code` itself specifies the actual focus of the observation. One would expect this element to be a cardinality of 1..1. The only circumstance in which the subject can be missing is when the observation is made by a device that does not know the patient. In this case, the observation SHALL be matched to a patient through some context/channel matching technique, and at this point, the observation should be updated. The subject of an Observation may in some cases be a procedure. This supports the regulatory inspection use case where observations are captured during inspections of a procedure that is being performed (independent of any particular patient or whether patient related at all).; (xsd)subject:(<BiologicallyDerivedProduct>
|<Device>
|<Group>
|<Location>
|<Medication>
|<NutritionProduct>
|<Organization>
|<Patient>
|<Practitioner>
|<Procedure>
|<Substance>)>?
[]< The actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also be an existing condition, an intervention, the subject's diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child's tracheostomy tube. In this example, the child is the patient of record and the mother is the focus. Typically, an observation is made about the subject - a patient, or group of patients, location, or device - and the distinction between the subject and what is directly measured for an observation is specified in the observation code itself ( e.g., "Blood Glucose") and does not need to be represented separately using this element. Use `specimen` if a reference to a specimen is required. If a code is required instead of a resource use either `bodysite` for bodysites or the standard extension [http://hl7.org/fhir/StructureDefinition/observation-focusCode](http://hl7.org/fhir/extensions/StructureDefinition-observation-focusCode.html).; (xsd)focus:Resource*>*
< The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made. This will typically be the encounter the event occurred within, but some events may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission laboratory tests).; (xsd)encounter:Encounter*>?
< The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the "physiologically relevant time". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself. At least a date should be present unless this observation is a historical report. For recording imprecise or "fuzzy" times (For example, a blood glucose measurement taken "after breakfast") use the [Timing](datatypes.html#timing) datatype which allow the measurement to be tied to regular life events.; (xsd)effective:(<dateTime>
|<instant>
|<Period>
|<Timing>)>?
< The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified. For Observations that don't require review and verification, it may be the same as the [`lastUpdated` ](resource-definitions.html#Meta.lastUpdated) time of the resource itself. For Observations that do require review and verification for certain updates, it might not be the same as the `lastUpdated` time of the resource itself due to a non-clinically significant update that doesn't require the new version to be reviewed and verified again.; (xsd)issued:instant>?
[]< Who was responsible for asserting the observed value as "true".; (xsd)performer:(<CareTeam>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>*
(<valueAttachment:Attachment>
|<valueBoolean:boolean>
|<valueCodeableConcept:CodeableConcept>
|<valueDateTime:dateTime>
|<valueInteger:integer>
|<valueMolecularSequence:MolecularSequence>
|<valuePeriod:Period>
|<valueQuantity:Quantity>
|<valueRange:Range>
|<valueRatio:Ratio>
|<valueSampledData:SampledData>
|<valueString:string>
|<valueTime:time>)?
< Provides a reason why the expected value in the element Observation.value[x] is missing. Null or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be "detected", "not detected", "inconclusive", or "specimen unsatisfactory".
The alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code "error" could be used when the measurement was not completed. Note that an observation may only be reported if there are values to report. For example differential cell counts values may be reported only when > 0. Because of these options, use-case agreements are required to interpret general observations for null or exceptional values. Binding: data-absent-reason (extensible, Codes specifying why the result (`Observation.value[x]`) is missing.); (xsd)dataAbsentReason:CodeableConcept>?
< + | ++ | +++ | - | -- | ---. Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Binding: observation-interpretation (extensible, Codes identifying interpretations of observations.); (xsd)interpretation:CodeableConcept>?
[]< Comments about result. May include general statements about the observation, or statements about significant, unexpected or unreliable results values, or information about its source when relevant to its interpretation.; (xsd)note:Annotation>*
< Indicates the site on the subject's body where the observation was made (i.e. the target site). Only used if not implicit in code found in Observation.code. In many systems, this may be represented as a related observation instead of an inline component. Binding: body-site (example, SNOMED CT Body site concepts); (xsd)bodySite:CodeableConcept>?
< Indicates the body structure on the subject's body where the observation was made (i.e. the target site). Only used if not implicit in code found in Observation.code or bodySite is used. In many systems, this may be represented as a related observation instead of an inline component.; (xsd)bodyStructure:BodyStructure*>?
< Indicates the mechanism used to perform the observation. Only used if not implicit in code for Observation.code. Binding: observation-methods (example, Methods for simple observations.); (xsd)method:CodeableConcept>?
< The specimen that was used when this observation was made. Should only be used if not implicit in code found in `Observation.code`. Observations are not made on specimens themselves; they are made on a subject, but in many cases by the means of a specimen. Note that although specimens are often involved, they are not always tracked and reported explicitly. Also note that observation resources may be used in contexts that track the specimen explicitly (e.g. Diagnostic Report).; (xsd)specimen:(<Group>
|<Specimen>)>?
< A reference to the device that generates the measurements or the device settings for the device. Note that this is not meant to represent a device involved in the transmission of the result, e.g., a gateway. Such devices may be documented using the Provenance resource where relevant.; (xsd)device:(<Device>
|<DeviceMetric>)>?
< Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an "OR". In other words, to represent two distinct target populations, two `referenceRange` elements would be used. Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.; (xsd)referenceRange:ldlcholesterol.referenceRange>
< This observation is a group observation (e.g. a battery, a panel of tests, a set of vital sign measurements) that includes the target as a member of the group. When using this element, an observation will typically have either a value or a set of related resources, although both may be present in some cases. For a discussion on the ways Observations can assembled in groups together, see [Notes](observation.html#obsgrouping) below. Note that a system may calculate results from [QuestionnaireResponse](questionnaireresponse.html) into a final score and represent the score as an Observation.; (xsd)hasMember:(<MolecularSequence>
|<Observation>
|<QuestionnaireResponse>)>{0,0}
< The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image. All the reference choices that are listed in this element can represent clinical observations and other measurements that may be the source for a derived value. The most common reference will be another Observation. For a discussion on the ways Observations can assembled in groups together, see [Notes](observation.html#obsgrouping) below.; (xsd)derivedFrom:(<DocumentReference>
|<GenomicStudy>
|<ImagingSelection>
|<ImagingStudy>
|<MolecularSequence>
|<Observation>
|<QuestionnaireResponse>)>{0,0}
[]< Some observations have multiple component observations. These component observations are expressed as separate code value pairs that share the same attributes. Examples include systolic and diastolic component observations for blood pressure measurement and multiple component observations for genetics observations. For a discussion on the ways Observations can be assembled in groups together see [Notes](observation.html#notes) below.; (xsd)component:ldlcholesterol.component>*
< LDL Cholesterol value. If a result is not available, use the comments field. - An observation may have:
1. a single value here
1. both a value and a set of related or component values
1. only a set of related or component values.
- If a value is present, the datatype for this element should be determined by the `code`.
- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.
- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.
- The usage of valueReference is restricted to the MolecularSequence resource when used as a definitional resource, not as a patient-specific finding. .
- For additional guidance, see the [Notes section](observation.html#notes) below.; (xsd)valueQuantity:Quantity>?🔗 Some observations have multiple component observations. These component observations are expressed as separate code value pairs that share the same attributes. Examples include systolic and diastolic component observations for blood pressure measurement and multiple component observations for genetics observations. For a discussion on the ways Observations can be assembled in groups together see [Notes](observation.html#notes) below.ldlcholesterol.component(xsd)(doc)=
<#base:Observation.component>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Describes what was observed. Sometimes this is called the observation "code". *All* code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. Binding: observation-codes (example, Codes identifying names of simple observations.); (xsd)code:CodeableConcept>
(<valueAttachment:Attachment>
|<valueBoolean:boolean>
|<valueCodeableConcept:CodeableConcept>
|<valueDateTime:dateTime>
|<valueInteger:integer>
|<valueMolecularSequence:MolecularSequence>
|<valuePeriod:Period>
|<valueQuantity:Quantity>
|<valueRange:Range>
|<valueRatio:Ratio>
|<valueSampledData:SampledData>
|<valueString:string>
|<valueTime:time>)?
< Provides a reason why the expected value in the element Observation.component.value[x] is missing. "Null" or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be "detected", "not detected", "inconclusive", or "test not done".
The alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code "error" could be used when the measurement was not completed. Because of these options, use-case agreements are required to interpret general observations for exceptional values. Binding: data-absent-reason (extensible, Codes specifying why the result (`Observation.value[x]`) is missing.); (xsd)dataAbsentReason:CodeableConcept>?
[]< A categorical assessment of an observation value. For example, high, low, normal. Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Binding: observation-interpretation (extensible, Codes identifying interpretations of observations.); (xsd)interpretation:CodeableConcept>*
[]< Guidance on how to interpret the value by comparison to a normal or recommended range. Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.; (xsd)referenceRange:Observation.referenceRange>*🔗 Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an "OR". In other words, to represent two distinct target populations, two `referenceRange` elements would be used. Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.ldlcholesterol.referenceRange(xsd)(doc)=
<#base:Observation.referenceRange>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The value of the low bound of the reference range. The low bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the low bound is omitted, it is assumed to be meaningless (e.g. reference range is <=2.3).; (xsd)low:SimpleQuantity>{0,0}
< <3.0 mmol/L. Per Australian NHF Recommendations. 3,0; (xsd)high:SimpleQuantity>
< The value of the normal value of the reference range. Binding: observation-referencerange-normalvalue (extensible, Codes identifying the normal value of the observation.); (xsd)normalValue:CodeableConcept>?
< Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range. This SHOULD be populated if there is more than one range. If this element is not present then the normal range is assumed. Binding: referencerange-meaning (preferred, Code for the meaning of a reference range.); (xsd)type:CodeableConcept>{0,0}
< Codes to indicate the target population this reference range applies to. For example, a reference range may be based on the normal population or a particular sex or race. Multiple `appliesTo` are interpreted as an "AND" of the target populations. For example, to represent a target population of African American females, both a code of female and a code for African American would be used. This SHOULD be populated if there is more than one range. If this element is not present then the normal population is assumed. Binding: referencerange-appliesto (example, Codes identifying the population the reference range applies to.); (xsd)appliesTo:CodeableConcept>{0,0}
< The age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so.; (xsd)age:Range>{0,0}
< Text based reference range in an observation which may be used when a quantitative range is not appropriate for an observation. An example would be a reference value of "Negative" or a list or table of "normals".; (xsd)text:markdown>?🔗 Identifies the observation(s) that triggered the performance of this observation.ldlcholesterol.triggeredBy(xsd)(doc)=
<#base:Observation.triggeredBy>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Reference to the triggering observation.; (xsd)observation:Observation*>
< The type of trigger.
Reflex | Repeat | Re-run. Binding: observation-triggeredbytype (required, The type of TriggeredBy Observation.); (xsd)type:code>
< Provides the reason why this observation was performed as a result of the observation(s) referenced.; (xsd)reason:string>?🔗 The Library resource is a general-purpose container for knowledge asset definitions. It can be used to describe and expose existing knowledge assets such as logic libraries and information model descriptions, as well as to describe a collection of knowledge assets.Library(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< An absolute URI that is used to identify this library when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this library is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the library is stored on different servers. Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.
The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions).
In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.; (xsd)url:uri>?
[]< A formal identifier that is used to identify this library when it is represented in other formats, or referenced in a specification, model, design or an instance. e.g. CMS or NQF identifiers for a measure artifact. Note that at least one identifier is required for non-experimental active artifacts. Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this library outside of FHIR, where it is not possible to use the logical URI.; (xsd)identifier:Identifier>*
< The identifier that is used to identify this version of the library when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the library author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts. There may be different library instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the library with the format [url]|[version]. The version SHOULD NOT contain a '#' - see [Business Version](resource.html#bv-format).; (xsd)version:string>?
< Indicates the mechanism used to compare versions to determine which is more current. If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined. Binding: version-algorithm (extensible, ); (xsd)versionAlgorithm:(<Coding>
|<string>)>?
< A natural language name identifying the library. This name should be usable as an identifier for the module by machine processing applications such as code generation. The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.; (xsd)name:string>?
< A short, descriptive, user-friendly title for the library. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.; (xsd)title:string>?
< An explanatory or alternate title for the library giving additional information about its content.; (xsd)subtitle:string>?
< The status of this library. Enables tracking the life-cycle of the content. Allows filtering of libraries that are appropriate for use vs. not.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization). Binding: publication-status (required, The lifecycle status of an artifact.); (xsd)status:code>
< A Boolean value to indicate that this library is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. Allows filtering of librarys that are appropriate for use versus not.; (xsd)experimental:boolean>?
< Identifies the type of library such as a Logic Library, Model Definition, Asset Collection, or Module Definition. Binding: library-type (extensible, The type of knowledge asset this library contains.); (xsd)type:CodeableConcept>
< A code or group definition that describes the intended subject of the contents of the library. Binding: participant-resource-types (extensible, The possible types of subjects for a library (E.g. Patient, Practitioner, Organization, Location, etc.).); (xsd)subject:(<CodeableConcept>
|<Group>)>?
< The date (and optionally time) when the library was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the library changes. The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the library. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)date:dateTime>?
< The name of the organization or individual responsible for the release and ongoing maintenance of the library. Usually an organization but may be an individual. The publisher (or steward) of the library is the organization or individual primarily responsible for the maintenance and upkeep of the library. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the library. This item SHOULD be populated unless the information is available from context.; (xsd)publisher:string>?
[]< Contact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)contact:ContactDetail>*
< A free text natural language description of the library from a consumer's perspective. This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the library as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the library is presumed to be the predominant language in the place the library was created).; (xsd)description:markdown>?
[]< The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate library instances. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.; (xsd)useContext:UsageContext>*
[]< A legal or geographic region in which the library is intended to be used. It may be possible for the library to be used in jurisdictions other than those for which it was originally designed or intended.
DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.) Binding: jurisdiction (extensible, Countries and regions within which this artifact is targeted for use.); (xsd)jurisdiction:CodeableConcept>*
< Explanation of why this library is needed and why it has been designed as it has. This element does not describe the usage of the library. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this library.; (xsd)purpose:markdown>?
< A detailed description of how the library is used from a clinical perspective.; (xsd)usage:markdown>?
< A copyright statement relating to the library and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the library. The short copyright declaration (e.g. (c) '2015+ xyz organization' should be sent in the copyrightLabel element.; (xsd)copyright:markdown>?
< A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved'). The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.; (xsd)copyrightLabel:string>?
< The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)approvalDate:date>?
< The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. If specified, this date follows the original approval date.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)lastReviewDate:date>?
< The period during which the library content was or is planned to be in active use. The effective period for a library determines when the content is applicable for usage and is independent of publication and review dates. For example, a library intended to be used for the year 2016 might be published in 2015.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)effectivePeriod:Period>?
[]< Descriptive topics related to the content of the library. Topics provide a high-level categorization of the library that can be useful for filtering and searching. DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'topic' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#topic and useContext.valueCodeableConcept indicating the topic) Binding: definition-topic (example, High-level categorization of the definition, used for searching, sorting, and filtering.); (xsd)topic:CodeableConcept>*
[]< An individiual or organization primarily involved in the creation and maintenance of the content.; (xsd)author:ContactDetail>*
[]< An individual or organization primarily responsible for internal coherence of the content.; (xsd)editor:ContactDetail>*
[]< An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the content. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)reviewer:ContactDetail>*
[]< An individual or organization asserted by the publisher to be responsible for officially endorsing the content for use in some setting. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)endorser:ContactDetail>*
[]< Related artifacts such as additional documentation, justification, or bibliographic references. Each related artifact is either an attachment, or a reference to another resource, but not both.; (xsd)relatedArtifact:RelatedArtifact>*
[]< The parameter element defines parameters used by the library.; (xsd)parameter:ParameterDefinition>*
[]< Describes a set of data that must be provided in order to be able to successfully perform the computations defined by the library.; (xsd)dataRequirement:DataRequirement>*
[]< The content of the library as an Attachment. The content may be a reference to a url, or may be directly embedded as a base-64 string. Either way, the contentType of the attachment determines how to interpret the content.; (xsd)content:Attachment>*🔗 An ExtensionLimitationSummary(xsd)(doc)=
<#base:Extension>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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. http://hl7.org/fhir/uv/order-catalog/StructureDefinition/LimitationSummary; (xsd)url:string>
< Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R5/extensibility.html) for a list).; (xsd)value:string>?🔗 Identifies two or more records (resource instances) that refer to the same real-world "occurrence".Linkage(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< Indicates whether the asserted set of linkages are considered to be "in effect". If false, any asserted linkages should not be considered current/relevant/applicable.; (xsd)active:boolean>?
< Identifies the user or organization responsible for asserting the linkages as well as the user or organization who establishes the context in which the nature of each linkage is evaluated.; (xsd)author:(<Organization>
|<Practitioner>
|<PractitionerRole>)>?
[]< Identifies which record considered as the reference to the same real-world occurrence as well as how the items should be evaluated within the collection of linked items.; (xsd)item:Linkage.item>+🔗 Identifies which record considered as the reference to the same real-world occurrence as well as how the items should be evaluated within the collection of linked items.Linkage.item(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Distinguishes which item is "source of truth" (if any) and which items are no longer considered to be current representations. Binding: linkage-type (required, Used to distinguish different roles a resource can play within a set of linked resources.); (xsd)type:code>
< The resource instance being linked as part of the group.; (xsd)resource:Resource*>🔗 The findings and interpretation of a general lipid lab profile. In this profile, mustSupport means that authoring systems must include the ability to report these elements, and processing systems must cater for them by either displaying them to the user or considering them appropriately in decision support systems.lipidprofile(xsd)(doc)=
<#base:DiagnosticReport>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< Identifiers assigned to this report by the performer or other systems. Usually assigned by the Information System of the diagnostic service provider (filler id).; (xsd)identifier:Identifier>*
[]< Details concerning a service requested. Note: Usually there is one test request for each result, however in some circumstances multiple test requests may be represented using a single test result resource. Note that there are also cases where one request leads to multiple reports.; (xsd)basedOn:(<CarePlan>
|<ImmunizationRecommendation>
|<MedicationRequest>
|<NutritionOrder>
|<ServiceRequest>)>*
< The status of the diagnostic report. Binding: diagnostic-report-status (required, The status of the diagnostic report.); (xsd)status:code>
[]< A code that classifies the clinical discipline, department or diagnostic service that created the report (e.g. cardiology, biochemistry, hematology, MRI). This is used for searching, sorting and display purposes. Multiple categories are allowed using various categorization schemes. The level of granularity is defined by the category concepts in the value set. More fine-grained filtering can be performed using the metadata and/or terminology hierarchy in DiagnosticReport.code. Binding: diagnostic-service-sections (example, HL7 V2 table 0074); (xsd)category:CodeableConcept>*
< LOINC Code for Lipid Panel with LDL. LOINC code includes "direct" LDL - does this mean LDL derived by measuring VLDL by ultracentrifugation? This panel includes both measured and calculated LDL. Binding: report-codes (preferred, LOINC Codes for Diagnostic Reports); (xsd)code:CodeableConcept>
< The subject of the report. Usually, but not always, this is a patient. However, diagnostic services also perform analyses on specimens collected from a variety of other sources.; (xsd)subject:(<BiologicallyDerivedProduct>
|<Device>
|<Group>
|<Location>
|<Medication>
|<Organization>
|<Patient>
|<Practitioner>
|<Substance>)>?
< The healthcare event (e.g. a patient and healthcare provider interaction) which this DiagnosticReport is about. This will typically be the encounter the event occurred within, but some events may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission laboratory tests).; (xsd)encounter:Encounter*>?
< The time or time-period the observed values are related to. When the subject of the report is a patient, this is usually either the time of the procedure or of specimen collection(s), but very often the source of the date/time is not known, only the date/time itself. If the diagnostic procedure was performed on the patient, this is the time it was performed. If there are specimens, the diagnostically relevant time can be derived from the specimen collection times, but the specimen information is not always available, and the exact relationship between the specimens and the diagnostically relevant time is not always automatic.; (xsd)effective:(<dateTime>
|<Period>)>?
< The date and time that this version of the report was made available to providers, typically after the report was reviewed and verified. May be different from the update time of the resource itself, because that is the status of the record (potentially a secondary copy), not the actual release time of the report.; (xsd)issued:instant>?
[]< The diagnostic service that is responsible for issuing the report. This is not necessarily the source of the atomic data items or the entity that interpreted the results. It is the entity that takes responsibility for the clinical report.; (xsd)performer:(<CareTeam>
|<Organization>
|<Practitioner>
|<PractitionerRole>)>*
[]< The practitioner or organization that is responsible for the report's conclusions and interpretations. Might not be the same entity that takes responsibility for the clinical report.; (xsd)resultsInterpreter:(<CareTeam>
|<Organization>
|<Practitioner>
|<PractitionerRole>)>*
[]< Details about the specimens on which this diagnostic report is based. If the specimen is sufficiently specified with a code in the test result name, then this additional data may be redundant. If there are multiple specimens, these may be represented per observation or group.; (xsd)specimen:Specimen*>*
[]< [Observations](observation.html) that are part of this diagnostic report. Observations can contain observations.; (xsd)result:Observation*>{3,4}
[]< Comments about the diagnostic report. May include general statements about the diagnostic report, or statements about significant, unexpected or unreliable results values contained within the diagnostic report, or information about its source when relevant to its interpretation.; (xsd)note:Annotation>*
[]< One or more links to full details of any study performed during the diagnostic investigation. An ImagingStudy might comprise a set of radiologic images obtained via a procedure that are analyzed as a group. Typically, this is imaging performed by DICOM enabled modalities, but this is not required. A fully enabled PACS viewer can use this information to provide views of the source images. A GenomicStudy might comprise one or more analyses, each serving a specific purpose. These analyses may vary in method (e.g., karyotyping, CNV, or SNV detection), performer, software, devices used, or regions targeted. For laboratory-type studies like GenomeStudy, type resources will be used for tracking additional metadata and workflow aspects of complex studies. ImagingStudy and the media element are somewhat overlapping - typically, the list of image references in the media element will also be found in one of the imaging study resources. However, each caters to different types of displays for different types of purposes. Neither, either, or both may be provided.; (xsd)study:(<GenomicStudy>
|<ImagingStudy>)>*
[]< This backbone element contains supporting information that was used in the creation of the report not included in the results already included in the report.; (xsd)supportingInfo:lipidprofile.supportingInfo>*
[]< A list of key images or data associated with this report. The images or data are generally created during the diagnostic process, and may be directly of the patient, or of treated specimens (i.e. slides of interest).; (xsd)media:lipidprofile.media>*
< Reference to a Composition resource instance that provides structure for organizing the contents of the DiagnosticReport. The Composition provides structure to the content of the DiagnosticReport (and only contains contents referenced in the DiagnosticReport) - e.g., to order the sections of an anatomic pathology structured report.; (xsd)composition:Composition*>?
< May include diagnosis or suggestions for follow up testing. It's not unusual for the lab to make some kind of interpretative comment on the set of results.; (xsd)conclusion:markdown>?
< No codes for a lipid panel. Not used in this context. Binding: clinical-findings (example, SNOMED CT Clinical Findings); (xsd)conclusionCode:CodeableConcept>{0,0}
[]< Rich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they SHALL be semantically equivalent. "application/pdf" is recommended as the most reliable and interoperable in this context.; (xsd)presentedForm:Attachment>*
< Reference to Cholesterol Result. Observations can contain observations.; (xsd)Cholesterol:cholesterol*>
< Group of elements for Triglyceride result. Observations can contain observations.; (xsd)Triglyceride:triglyceride*>
< Group of elements for HDL Cholesterol result. Observations can contain observations.; (xsd)HDLCholesterol:hdlcholesterol*>
< LDL Cholesterol result, if reported. Observations can contain observations.; (xsd)LDLCholesterol:ldlcholesterol*>?🔗 A list of key images or data associated with this report. The images or data are generally created during the diagnostic process, and may be directly of the patient, or of treated specimens (i.e. slides of interest).lipidprofile.media(xsd)(doc)=
<#base:DiagnosticReport.media>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A comment about the image or data. Typically, this is used to provide an explanation for why the image or data is included, or to draw the viewer's attention to important features. The comment should be displayed with the image or data. It would be common for the report to include additional discussion of the image or data contents or in other sections such as the conclusion.; (xsd)comment:string>?
< Reference to the image or data source.; (xsd)link:DocumentReference*>🔗 This backbone element contains supporting information that was used in the creation of the report not included in the results already included in the report.lipidprofile.supportingInfo(xsd)(doc)=
<#base:DiagnosticReport.supportingInfo>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The code value for the role of the supporting information in the diagnostic report. Binding: http://terminology.hl7.org/ValueSet/v2-0936 (example, The code value for the role of the supporting information in the diagnostic report.); (xsd)type:CodeableConcept>
< The reference for the supporting information in the diagnostic report.; (xsd)reference:(<Citation>
|<DiagnosticReport>
|<Observation>
|<Procedure>)>🔗 A List is a curated collection of resources, for things such as problem lists, allergy lists, facility list, organization list, etc.List(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< Identifier for the List assigned for business purposes outside the context of FHIR.; (xsd)identifier:Identifier>*
< Indicates the current state of this list. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. Binding: list-status (required, The current state of the list.); (xsd)status:code>
< How this list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted. This element is labeled as a modifier because a change list must not be misunderstood as a complete list. Binding: list-mode (required, The processing mode that applies to this list.); (xsd)mode:code>
< A label for the list assigned by the author.; (xsd)title:string>?
< This code defines the purpose of the list - why it was created. If there is no code, the purpose of the list is implied where it is used, such as in a document section using Document.section.code. Binding: list-example-codes (example, What the purpose of a list is.); (xsd)code:CodeableConcept>?
[]< The common subject(s) (or patient(s)) of the resources that are in the list if there is one (or a set of subjects). Some purely arbitrary lists do not have a common subject, so this is optional. Lists having multiple subjects may raise challenges for systems that base access control or other security considerations on linkages to 'subject'. E.g. if a List is associated with multiple Patient subjects, then it would be nominally part of multiple patient compartments, which might drive access rights.; (xsd)subject:Resource*>*
< The encounter that is the context in which this list was created.; (xsd)encounter:Encounter*>?
< Date list was last reviewed/revised and determined to be 'current'. The actual important date is the date of currency of the resources that were summarized, but it is usually assumed that these are current when the preparation occurs.; (xsd)date:dateTime>?
< The entity responsible for deciding what the contents of the list were. Where the list was created by a human, this is the same as the author of the list. The primary source is the entity that made the decisions what items are in the list. This may be software or user.; (xsd)source:(<CareTeam>
|<Device>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>?
< What order applies to the items in the list. Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order. Binding: list-order (preferred, What order applies to the items in a list.); (xsd)orderedBy:CodeableConcept>?
[]< Comments that apply to the overall list.; (xsd)note:Annotation>*
[]< Entries in this list. If there are no entries in the list, an emptyReason SHOULD be provided.; (xsd)entry:List.entry>*
< If the list is empty, why the list is empty. The various reasons for an empty list make a significant interpretation to its interpretation. Note that this code is for use when the entire list has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases. Binding: list-empty-reason (preferred, If a list is empty, why it is empty.); (xsd)emptyReason:CodeableConcept>?🔗 Entries in this list. If there are no entries in the list, an emptyReason SHOULD be provided.List.entry(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The flag allows the system constructing the list to indicate the role and significance of the item in the list. The flag can only be understood in the context of the List.code. If the flag means that the entry has actually been deleted from the list, the deleted element SHALL be true Binding: list-item-flag (example, Codes that provide further information about the reason and meaning of the item in the list.); (xsd)flag:CodeableConcept>?
< True if this item is marked as deleted in the list. If the flag means that the entry has actually been deleted from the list, the deleted element SHALL be true. A deleted entry should be displayed in narrative as deleted. This element is labeled as a modifier because it indicates that an item is (to be) no longer in the list.; (xsd)deleted:boolean>?
< When this item was added to the list.; (xsd)date:dateTime>?
< A reference to the actual resource from which data was derived.; (xsd)item:Resource*>🔗 Details and position information for a place where services are provided and resources and participants may be stored, found, contained, or accommodated.Location(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< Unique code or number identifying the location to its users.; (xsd)identifier:Identifier>*
< The status property covers the general availability of the resource, not the current value which may be covered by the operationStatus, or by a schedule/slots if they are configured for the location. Binding: location-status (required, Indicates whether the location is still in use.); (xsd)status:code>?
< The operational status covers operation values most relevant to beds (but can also apply to rooms/units/chairs/etc. such as an isolation unit/dialysis chair). This typically covers concepts such as contamination, housekeeping, and other activities like maintenance. Binding: http://terminology.hl7.org/ValueSet/v2-0116 (preferred, The operational status if the location (where typically a bed/room).); (xsd)operationalStatus:Coding>?
< Name of the location as used by humans. Does not need to be unique. If the name of a location changes, consider putting the old name in the alias column so that it can still be located through searches.; (xsd)name:string>?
[]< A list of alternate names that the location is known as, or was known as, in the past. There are no dates associated with the alias/historic names, as this is not intended to track when names were used, but to assist in searching so that older names can still result in identifying the location.; (xsd)alias:string>*
< Description of the Location, which helps in finding or referencing the place.; (xsd)description:markdown>?
< Indicates whether a resource instance represents a specific location or a class of locations. This is labeled as a modifier because whether or not the location is a class of locations changes how it can be used and understood. Binding: location-mode (required, Indicates whether a resource instance represents a specific location or a class of locations.); (xsd)mode:code>?
[]< Indicates the type of function performed at the location. Binding: http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType (extensible, Indicates the type of function performed at the location.); (xsd)type:CodeableConcept>*
[]< The contact details of communication devices available at the location. This can include addresses, phone numbers, fax numbers, mobile numbers, email addresses and web sites. The address/telecom use code 'home' are not to be used. Note that these contacts are not the contact details of people who provide the service (that would be through PractitionerRole), these are official contacts for the Healthcare itself for specific purposes. E.g. Mailing Addresses, Billing Addresses, Contact numbers for Booking or Billing Enquiries, general web address, web address for online bookings etc.
If this is empty (or the type of interest is empty), refer to the organization's contacts.; (xsd)contact:ExtendedContactDetail>*
< Physical location. Additional addresses should be recorded using another instance of the Location resource, or via the Organization.; (xsd)address:Address>?
< Physical form of the location, e.g. building, room, vehicle, road, virtual. Binding: location-form (example, Physical form of the location.); (xsd)form:CodeableConcept>?
< The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML). To define a boundary shape for this location use the standard extension `[http://hl7.org/fhir/StructureDefinition/location-boundary-geojson](http://hl7.org/fhir/extensions/StructureDefinition-location-boundary-geojson.html)`, and search using the `contains` special search parameter.; (xsd)position:Location.position>?
< The organization responsible for the provisioning and upkeep of the location. This can also be used as the part of the organization hierarchy where this location provides services. These services can be defined through the HealthcareService resource.; (xsd)managingOrganization:Organization*>?
< Another Location of which this Location is physically a part of.; (xsd)partOf:Location*>?
[]< Collection of characteristics (attributes). These could be such things as is wheelchair accessible. Binding: location-characteristic (example, A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy).); (xsd)characteristic:CodeableConcept>*
[]< What days/times during a week is this location usually open, and any exceptions where the location is not available. This type of information is commonly found published in directories and on websites informing customers when the facility is available.
Specific services within the location may have their own hours which could be shorter (or longer) than the locations hours.
Systems may choose to render availability differently than it is exchanged on the interface. For example, rather than "Mon, Tue, Wed, Thur, Fri from 9am-12am; Mon, Tue, Wed, Thur, Fri from 1pm-5pm" as would be implied by two availableTime repetitions, an application could render this information as "Mon-Fri 9-12am and 1-5pm".
The availableStartTime is the opening time, and the availableEndTime is the closing time.; (xsd)hoursOfOperation:Availability>*
[]< Connection details of a virtual service (e.g. shared conference call facility with dedicated number/details). There are two types of virtual meetings that often exist:
* a persistent, virtual meeting room that can only be used for a single purpose at a time,
* and a dynamic virtual meeting room that is generated on demand for a specific purpose.
Implementers may consider using Appointment.virtualService for virtual meeting rooms that are generated on-demand.; (xsd)virtualService:VirtualServiceDetail>*
[]< Technical endpoints providing access to services operated for the location.; (xsd)endpoint:Endpoint*>*🔗 The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML). To define a boundary shape for this location use the standard extension `[http://hl7.org/fhir/StructureDefinition/location-boundary-geojson](http://hl7.org/fhir/extensions/StructureDefinition-location-boundary-geojson.html)`, and search using the `contains` special search parameter.Location.position(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Longitude. The value domain and the interpretation are the same as for the text of the longitude element in KML (see notes on Location main page).; (xsd)longitude:decimal>
< Latitude. The value domain and the interpretation are the same as for the text of the latitude element in KML (see notes on Location main page).; (xsd)latitude:decimal>
< Altitude. The value domain and the interpretation are the same as for the text of the altitude element in KML (see notes on Location main page).; (xsd)altitude:decimal>?🔗 The Library resource is a general-purpose container for knowledge asset definitions. It can be used to describe and expose existing knowledge assets such as logic libraries and information model descriptions, as well as to describe a collection of knowledge assets.logiclibrary(xsd)(doc)=
<#base:shareablelibrary>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< An Extension; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< An absolute URI that is used to identify this library when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this library is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the library is stored on different servers. Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.
The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions).
In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.; (xsd)url:uri>
[]< A formal identifier that is used to identify this library when it is represented in other formats, or referenced in a specification, model, design or an instance. e.g. CMS or NQF identifiers for a measure artifact. Note that at least one identifier is required for non-experimental active artifacts. Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this library outside of FHIR, where it is not possible to use the logical URI.; (xsd)identifier:Identifier>*
< The identifier that is used to identify this version of the library when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the library author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts. There may be different library instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the library with the format [url]|[version]. The version SHOULD NOT contain a '#' - see [Business Version](resource.html#bv-format).; (xsd)version:string>
< Indicates the mechanism used to compare versions to determine which is more current. If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined. Binding: version-algorithm (extensible, ); (xsd)versionAlgorithm:(<Coding>
|<string>)>?
< A natural language name identifying the library. This name should be usable as an identifier for the module by machine processing applications such as code generation. The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.; (xsd)name:string>?
< A short, descriptive, user-friendly title for the library. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.; (xsd)title:string>
< An explanatory or alternate title for the library giving additional information about its content.; (xsd)subtitle:string>?
< The status of this library. Enables tracking the life-cycle of the content. Allows filtering of libraries that are appropriate for use vs. not.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization). Binding: publication-status (required, The lifecycle status of an artifact.); (xsd)status:code>
< A Boolean value to indicate that this library is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. Allows filtering of librarys that are appropriate for use versus not.; (xsd)experimental:boolean>?
< Identifies the type of library such as a Logic Library, Model Definition, Asset Collection, or Module Definition. Binding: library-type (extensible, The type of knowledge asset this library contains.); (xsd)type:CodeableConcept>
< A code or group definition that describes the intended subject of the contents of the library. Binding: participant-resource-types (extensible, The possible types of subjects for a library (E.g. Patient, Practitioner, Organization, Location, etc.).); (xsd)subject:(<CodeableConcept>
|<Group>)>?
< The date (and optionally time) when the library was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the library changes. The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the library. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)date:dateTime>?
< The name of the organization or individual responsible for the release and ongoing maintenance of the library. Usually an organization but may be an individual. The publisher (or steward) of the library is the organization or individual primarily responsible for the maintenance and upkeep of the library. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the library. This item SHOULD be populated unless the information is available from context.; (xsd)publisher:string>?
[]< Contact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)contact:ContactDetail>*
< A free text natural language description of the library from a consumer's perspective. This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the library as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the library is presumed to be the predominant language in the place the library was created).; (xsd)description:markdown>
[]< The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate library instances. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.; (xsd)useContext:UsageContext>*
[]< A legal or geographic region in which the library is intended to be used. It may be possible for the library to be used in jurisdictions other than those for which it was originally designed or intended.
DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.) Binding: jurisdiction (extensible, Countries and regions within which this artifact is targeted for use.); (xsd)jurisdiction:CodeableConcept>*
< Explanation of why this library is needed and why it has been designed as it has. This element does not describe the usage of the library. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this library.; (xsd)purpose:markdown>?
< A detailed description of how the library is used from a clinical perspective.; (xsd)usage:markdown>?
< A copyright statement relating to the library and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the library. The short copyright declaration (e.g. (c) '2015+ xyz organization' should be sent in the copyrightLabel element.; (xsd)copyright:markdown>?
< A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved'). The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.; (xsd)copyrightLabel:string>?
< The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)approvalDate:date>?
< The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. If specified, this date follows the original approval date.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)lastReviewDate:date>?
< The period during which the library content was or is planned to be in active use. The effective period for a library determines when the content is applicable for usage and is independent of publication and review dates. For example, a library intended to be used for the year 2016 might be published in 2015.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)effectivePeriod:Period>?
[]< Descriptive topics related to the content of the library. Topics provide a high-level categorization of the library that can be useful for filtering and searching. DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'topic' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#topic and useContext.valueCodeableConcept indicating the topic) Binding: definition-topic (example, High-level categorization of the definition, used for searching, sorting, and filtering.); (xsd)topic:CodeableConcept>*
[]< An individiual or organization primarily involved in the creation and maintenance of the content.; (xsd)author:ContactDetail>*
[]< An individual or organization primarily responsible for internal coherence of the content.; (xsd)editor:ContactDetail>*
[]< An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the content. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)reviewer:ContactDetail>*
[]< An individual or organization asserted by the publisher to be responsible for officially endorsing the content for use in some setting. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)endorser:ContactDetail>*
[]< Related artifacts such as additional documentation, justification, or bibliographic references. Each related artifact is either an attachment, or a reference to another resource, but not both.; (xsd)relatedArtifact:RelatedArtifact>*
[]< The parameter element defines parameters used by the library.; (xsd)parameter:ParameterDefinition>*
[]< Describes a set of data that must be provided in order to be able to successfully perform the computations defined by the library.; (xsd)dataRequirement:DataRequirement>*
[]< The content of the library as an Attachment. The content may be a reference to a url, or may be directly embedded as a base-64 string. Either way, the contentType of the attachment determines how to interpret the content.; (xsd)content:logiclibrary.content>*
[]< Defines a knowledge capability afforded by this knowledge artifact.; (xsd)knowledgeCapability:Extension>*
[]< Defines a knowledge representation level provided by this knowledge artifact.; (xsd)knowledgeRepresentationLevel:Extension>*
[]< A comment containing additional documentation, a review comment, usage guidance, or other relevant information from a particular user.; (xsd)artifactComment:Extension>*
[]< Defines a code directly referenced by artifact logic, as opposed to a value set. Direct reference codes may be the target of data requirements.; (xsd)directReferenceCode:Extension>*
[]< Related artifacts such as additional documentation, justification, or bibliographic references. Each related artifact is either an attachment, or a reference to another resource, but not both.; (xsd)dependency:logiclibrary.dependency>*🔗 The content of the library as an Attachment. The content may be a reference to a url, or may be directly embedded as a base-64 string. Either way, the contentType of the attachment determines how to interpret the content.logiclibrary.content(xsd)(doc)=
<#base:Attachment>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< 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. Binding: mimetypes (required, BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)); (xsd)contentType:code>?
< The human language of the content. The value can be any valid value according to BCP 47. Binding: all-languages (required, IETF language tag for a human language.); (xsd)language:code>?
< 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.; (xsd)data:base64Binary>?
< 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.; (xsd)url>?
< 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.; (xsd)size:integer64>?
< 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.; (xsd)hash:base64Binary>?
< A label or set of text to display in place of the data. May sometimes be derived from the source filename.; (xsd)title:string>?
< The date that the attachment was first created.; (xsd)creation:dateTime>?
< Height of the image in pixels (photo/video).; (xsd)height:positiveInt>?
< Width of the image in pixels (photo/video).; (xsd)width:positiveInt>?
< The number of frames in a photo. This is used with a multi-page fax, or an imaging acquisition context that takes multiple slices in a single image, or an animated gif. If there is more than one frame, this SHALL have a value in order to alert interface software that a multi-frame capable rendering widget is required. if the number of frames is not supplied, the value may be unknown. Applications should not assume that there is only one frame unless it is explicitly stated.; (xsd)frames:positiveInt>?
< The duration of the recording in seconds - for audio and video. The duration might differ from occurrencePeriod if recording was paused.; (xsd)duration:decimal>?
< The number of pages when printed.; (xsd)pages:positiveInt>?🔗 Related artifacts such as additional documentation, justification, or bibliographic references. Each related artifact is either an attachment, or a reference to another resource, but not both.logiclibrary.dependency(xsd)(doc)=
<#base:RelatedArtifact>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< The type of relationship to the related artifact. The presence of both sides of a relationship type (e.g. successor and predecessor) is required to support use cases where one side of a relationship is not represented in FHIR. However, this feature SHALL NOT be used to create bi-directional resource links in FHIR instances. Specifically, following the methodology of "new points to old" and "many points to one", when using related artifact elements to describe and reference FHIR resources, the type element SHALL be drawn from the fhir-related-artifact-type ValueSet. Binding: related-artifact-type (required, The type of relationship to the related artifact.) depends-on; (xsd)type:code>
[]< Provides additional classifiers of the related artifact. Binding: citation-artifact-classifier (example, Additional classifiers for the related artifact.); (xsd)classifier:CodeableConcept>*
< A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index.; (xsd)label:string>?
< A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.; (xsd)display:string>?
< 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.; (xsd)citation:markdown>?
< The document being referenced, represented as an attachment. This is exclusive with the resource element.; (xsd)document:Attachment>?
< The related artifact, 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.; (xsd)resource:(<CodeSystem>
|<Library>
|<ValueSet>)>
< The related artifact, if the artifact is not a canonical resource, or a resource reference to a canonical resource. If both resource and resourceReference are present, they SHOULD be consistent and reference the same resource. Although relatedArtifact is intended to support references to definitional resources, there are cases where non-definitional resources can be definitional (such as Location where the kind is mode). Related artifacts SHOULD be used to reference definitional resources, and profiles SHOULD be used to make that explicit for particular use cases.; (xsd)resourceReference:Resource*>?
< The publication status of the artifact being referred to. Binding: publication-status (required, Publication status of an artifact being referred to.); (xsd)publicationStatus:code>?
< The date of publication of the artifact being referred to.; (xsd)publicationDate:date>?🔗 The definition and characteristics of a medicinal manufactured item, such as a tablet or capsule, as contained in a packaged medicinal product.ManufacturedItemDefinition(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< Unique identifier.; (xsd)identifier:Identifier>*
< The status of this item. Enables tracking the life-cycle of the content. Allows filtering of manufactured items that are appropriate for use versus not. Binding: publication-status (required, The lifecycle status of an artifact.); (xsd)status:code>
< A descriptive name applied to this item.; (xsd)name:string>?
< Dose form as manufactured and before any transformation into the pharmaceutical product. Binding: manufactured-dose-form (example, Dose form for a medication, in the form suitable for administering to the patient, after mixing, where necessary.); (xsd)manufacturedDoseForm:CodeableConcept>
< The “real-world” units in which the quantity of the manufactured item is described. Binding: unit-of-presentation (example, The presentation type in which an administrable medicinal product is given to a patient.); (xsd)unitOfPresentation:CodeableConcept>?
[]< Manufacturer of the item, one of several possible.; (xsd)manufacturer:Organization*>*
[]< Allows specifying that an item is on the market for sale, or that it is not available, and the dates and locations associated.; (xsd)marketingStatus:MarketingStatus>*
[]< The ingredients of this manufactured item. This is only needed if the ingredients are not specified by incoming references from the Ingredient resource. Binding: substance-codes (example, This value set includes all substance codes from SNOMED CT - provided as an exemplar value set.); (xsd)ingredient:CodeableConcept>*
[]< General characteristics of this item.; (xsd)property:ManufacturedItemDefinition.property>*
[]< Physical parts of the manufactured item, that it is intrisically made from. This is distinct from the ingredients that are part of its chemical makeup.; (xsd)component:ManufacturedItemDefinition.component>*🔗 Physical parts of the manufactured item, that it is intrisically made from. This is distinct from the ingredients that are part of its chemical makeup.ManufacturedItemDefinition.component(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Defining type of the component e.g. shell, layer, ink.; (xsd)type:CodeableConcept>
[]< The function of this component within the item e.g. delivers active ingredient, masks taste.; (xsd)function:CodeableConcept>*
[]< The measurable amount of total quantity of all substances in the component, expressable in different ways (e.g. by mass or volume).; (xsd)amount:Quantity>*
[]< A reference to a constituent of the manufactured item as a whole, linked here so that its component location within the item can be indicated. This not where the item's ingredient are primarily stated (for which see Ingredient.for or ManufacturedItemDefinition.ingredient).; (xsd)constituent:ManufacturedItemDefinition.component.constituent>*
[]< General characteristics of this component.; (xsd)property:ManufacturedItemDefinition.property>*
[]< A component that this component contains or is made from.; (xsd)component:ManufacturedItemDefinition.component>*🔗 A reference to a constituent of the manufactured item as a whole, linked here so that its component location within the item can be indicated. This not where the item's ingredient are primarily stated (for which see Ingredient.for or ManufacturedItemDefinition.ingredient).ManufacturedItemDefinition.component.constituent(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< The measurable amount of the substance, expressable in different ways (e.g. by mass or volume).; (xsd)amount:Quantity>*
[]< The physical location of the constituent/ingredient within the component. Example – if the component is the bead in the capsule, then the location would be where the ingredient resides within the product part – intragranular, extra-granular, etc.; (xsd)location:CodeableConcept>*
[]< The function of this constituent within the component e.g. binder.; (xsd)function:CodeableConcept>*
[]< The ingredient that is the constituent of the given component.; (xsd)hasIngredient:Ingredient*>*🔗 General characteristics of this item.ManufacturedItemDefinition.property(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A code expressing the type of characteristic. Binding: product-characteristic-codes (example, This value set includes all observable entity codes from SNOMED CT - provided as an exemplar value set.); (xsd)type:CodeableConcept>
(<valueAttachment:Attachment>
|<valueBinary:Binary>
|<valueBoolean:boolean>
|<valueCodeableConcept:CodeableConcept>
|<valueDate:date>
|<valueMarkdown:markdown>
|<valueQuantity:Quantity>)?🔗 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(xsd)(doc)=
<#base:string>
< unique id for the element within a resource (for internal references); (xsd)id:string>?
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< Primitive value for markdown; (xsd)value:string>?🔗 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(xsd)(doc)=
<#base:BackboneType>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The country in which the marketing authorization has been granted shall be specified It should be specified using the ISO 3166 ‑ 1 alpha-2 code elements.; (xsd)country:CodeableConcept>?
< Where a Medicines Regulatory Agency has granted a marketing authorization for which specific provisions within a jurisdiction apply, the jurisdiction can be specified using an appropriate controlled terminology The controlled term and the controlled term identifier shall be specified.; (xsd)jurisdiction:CodeableConcept>?
< This attribute provides information on the status of the marketing of the medicinal product See ISO/TS 20443 for more information and examples.; (xsd)status:CodeableConcept>
< The date when the Medicinal Product is placed on the market by the Marketing Authorization Holder (or where applicable, the manufacturer/distributor) in a country and/or jurisdiction shall be provided A complete date consisting of day, month and year shall be specified using the ISO 8601 date format NOTE “Placed on the market” refers to the release of the Medicinal Product into the distribution chain.; (xsd)dateRange:Period>?
< The date when the Medicinal Product is placed on the market by the Marketing Authorization Holder (or where applicable, the manufacturer/distributor) in a country and/or jurisdiction shall be provided A complete date consisting of day, month and year shall be specified using the ISO 8601 date format NOTE “Placed on the market” refers to the release of the Medicinal Product into the distribution chain.; (xsd)restoreDate:dateTime>?🔗 The Measure resource provides the definition of a quality measure.Measure(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< An absolute URI that is used to identify this measure when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this measure is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the measure is stored on different servers. Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.
The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions).
In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.; (xsd)url:uri>?
[]< A formal identifier that is used to identify this measure when it is represented in other formats, or referenced in a specification, model, design or an instance. Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this measure outside of FHIR, where it is not possible to use the logical URI.; (xsd)identifier:Identifier>*
< The identifier that is used to identify this version of the measure when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the measure author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts. There may be different measure instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the measure with the format [url]|[version]. The version SHOULD NOT contain a '#' - see [Business Version](resource.html#bv-format).; (xsd)version:string>?
< Indicates the mechanism used to compare versions to determine which is more current. If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined. Binding: version-algorithm (extensible, ); (xsd)versionAlgorithm:(<Coding>
|<string>)>?
< A natural language name identifying the measure. This name should be usable as an identifier for the module by machine processing applications such as code generation. The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.; (xsd)name:string>?
< A short, descriptive, user-friendly title for the measure. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.; (xsd)title:string>?
< An explanatory or alternate title for the measure giving additional information about its content.; (xsd)subtitle:string>?
< The status of this measure. Enables tracking the life-cycle of the content. Allows filtering of measures that are appropriate for use versus not.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization). Binding: publication-status (required, The lifecycle status of an artifact.); (xsd)status:code>
< A Boolean value to indicate that this measure is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. Allows filtering of measures that are appropriate for use versus not.; (xsd)experimental:boolean>?
< The intended subjects for the measure. If this element is not provided, a Patient subject is assumed, but the subject of the measure can be anything. The subject of the measure is critical in interpreting the criteria definitions, as the logic in the measures is evaluated with respect to a particular subject. This corresponds roughly to the notion of a Compartment in that it limits what content is available based on its relationship to the subject. In CQL, this corresponds to the context declaration. Binding: participant-resource-types (extensible, The possible types of subjects for a measure (E.g. Patient, Practitioner, Organization, Location, etc.).); (xsd)subject:(<CodeableConcept>
|<Group>)>?
< The population basis specifies the type of elements in the population. For a subject-based measure, this is boolean (because the subject and the population basis are the same, and the population criteria define yes/no values for each individual in the population). For measures that have a population basis that is different than the subject, this element specifies the type of the population basis. For example, an encounter-based measure has a subject of Patient and a population basis of Encounter, and the population criteria all return lists of Encounters. For a subject-based measure, the population basis is simply boolean; all the criteria are expressed as true/false conditions that determine membership of an individual case in the population. For non-subject-based measures, the population basis can be any resource type, and the criteria are queries that return the subject's contribution to the population as a list of that resource type. For example, for a procedure-based measure, the population criteria would return lists of procedures that should be included in each population. Binding: fhir-types (required, ); (xsd)basis:code>?
< The date (and optionally time) when the measure was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the measure changes. The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the measure. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)date:dateTime>?
< The name of the organization or individual responsible for the release and ongoing maintenance of the measure. Usually an organization but may be an individual. The publisher (or steward) of the measure is the organization or individual primarily responsible for the maintenance and upkeep of the measure. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the measure. This item SHOULD be populated unless the information is available from context.; (xsd)publisher:string>?
[]< Contact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)contact:ContactDetail>*
< A free text natural language description of the measure from a consumer's perspective. This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the measure as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the measure is presumed to be the predominant language in the place the measure was created).; (xsd)description:markdown>?
[]< The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate measure instances. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.; (xsd)useContext:UsageContext>*
[]< A legal or geographic region in which the measure is intended to be used. It may be possible for the measure to be used in jurisdictions other than those for which it was originally designed or intended.
DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.) Binding: jurisdiction (extensible, Countries and regions within which this artifact is targeted for use.); (xsd)jurisdiction:CodeableConcept>*
< Explanation of why this measure is needed and why it has been designed as it has. This element does not describe the usage of the measure. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this measure.; (xsd)purpose:markdown>?
< A detailed description, from a clinical perspective, of how the measure is used. This metadata element was typically referred to as Guidance in HQMF; (xsd)usage:markdown>?
< A copyright statement relating to the measure and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the measure. The short copyright declaration (e.g. (c) '2015+ xyz organization' should be sent in the copyrightLabel element.; (xsd)copyright:markdown>?
< A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved'). The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.; (xsd)copyrightLabel:string>?
< The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)approvalDate:date>?
< The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. If specified, this date follows the original approval date.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)lastReviewDate:date>?
< The period during which the measure content was or is planned to be in active use. The effective period for a measure determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 might be published in 2015.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)effectivePeriod:Period>?
[]< Descriptive topics related to the content of the measure. Topics provide a high-level categorization grouping types of measures that can be useful for filtering and searching. DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'topic' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#topic and useContext.valueCodeableConcept indicating the topic) Binding: definition-topic (example, High-level categorization of the definition, used for searching, sorting, and filtering.); (xsd)topic:CodeableConcept>*
[]< An individiual or organization primarily involved in the creation and maintenance of the content.; (xsd)author:ContactDetail>*
[]< An individual or organization primarily responsible for internal coherence of the content.; (xsd)editor:ContactDetail>*
[]< An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the content. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)reviewer:ContactDetail>*
[]< An individual or organization asserted by the publisher to be responsible for officially endorsing the content for use in some setting. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)endorser:ContactDetail>*
[]< Related artifacts such as additional documentation, justification, or bibliographic references. Each related artifact is either an attachment, or a reference to another resource, but not both.; (xsd)relatedArtifact:RelatedArtifact>*
[]< A reference to a Library resource containing the formal logic used by the measure.; (xsd)library:Library*>*
< Notices and disclaimers regarding the use of the measure or related to intellectual property (such as code systems) referenced by the measure.; (xsd)disclaimer:markdown>?
< Indicates how the calculation is performed for the measure, including proportion, ratio, continuous-variable, and cohort. The value set is extensible, allowing additional measure scoring types to be represented. Binding: http://terminology.hl7.org/ValueSet/measure-scoring (extensible, The scoring type of the measure.); (xsd)scoring:CodeableConcept>?
< Defines the expected units of measure for the measure score. This element SHOULD be specified as a UCUM unit. When this element is specified, implementations are expected to report measure scores in the specified units. Note that this may involve unit conversion if the expected units are different than the units of the resulting score calculation. In this case, unit conversions SHALL be performed according to the unit conversion semantics specified by UCUM. Binding: measure-scoring-unit (example, ); (xsd)scoringUnit:CodeableConcept>?
< If this is a composite measure, the scoring method used to combine the component measures to determine the composite score. Binding: composite-measure-scoring (extensible, The composite scoring method of the measure.); (xsd)compositeScoring:CodeableConcept>?
[]< Indicates whether the measure is used to examine a process, an outcome over time, a patient-reported outcome, or a structure measure such as utilization. Binding: measure-type (extensible, The type of measure (includes codes from 2.16.840.1.113883.1.11.20368).); (xsd)type:CodeableConcept>*
< A description of the risk adjustment factors that may impact the resulting score for the measure and how they may be accounted for when computing and reporting measure results. Describes the method of adjusting for clinical severity and conditions present at the start of care that can influence patient outcomes for making valid comparisons of outcome measures across providers. Indicates whether a measure is subject to the statistical process for reducing, removing, or clarifying the influences of confounding factors to allow for more useful comparisons.; (xsd)riskAdjustment:markdown>?
< Describes how to combine the information calculated, based on logic in each of several populations, into one summarized result. The measure rate for an organization or clinician is based upon the entities’ aggregate data and summarizes the performance of the entity over a given time period (e.g., monthly, quarterly, yearly). The aggregated data are derived from the results of a specific measure algorithm and, if appropriate, the application of specific risk adjustment models. Can also be used to describe how to risk adjust the data based on supplemental data elements described in the eMeasure (e.g., pneumonia hospital measures antibiotic selection in the ICU versus non-ICU and then the roll-up of the two). This could be applied to aggregated cohort measure definitions (e.g., CDC's aggregate reporting for TB at the state level).; (xsd)rateAggregation:markdown>?
< Provides a succinct statement of the need for the measure. Usually includes statements pertaining to importance criterion: impact, gap in care, and evidence.; (xsd)rationale:markdown>?
< Provides a summary of relevant clinical guidelines or other clinical recommendations supporting the measure.; (xsd)clinicalRecommendationStatement:markdown>?
< Information on whether an increase or decrease in score is the preferred result (e.g., a higher score indicates better quality OR a lower score indicates better quality OR quality is within a range). Binding: measure-improvement-notation (required, Observation values that indicate what change in a measurement value or score is indicative of an improvement in the measured item or scored issue.); (xsd)improvementNotation:CodeableConcept>?
[]< Provides a description of an individual term used within the measure.; (xsd)term:Measure.term>*
< Additional guidance for the measure including how it can be used in a clinical context, and the intent of the measure. NOTE: This element is deprecated in favor of the usage element; (xsd)guidance:markdown>?
[]< A group of population criteria for the measure.; (xsd)group:Measure.group>*
[]< The supplemental data criteria for the measure report, specified as either the name of a valid CQL expression within a referenced library, or a valid FHIR Resource Path. Note that supplemental data are reported as resources for each patient and referenced in the supplementalData element of the MeasureReport. If the supplementalData expression results in a value other than a resource, it is reported using an Observation resource, typically contained in the resulting MeasureReport. See the MeasureReport resource and the Quality Reporting topic for more information.; (xsd)supplementalData:Measure.supplementalData>*🔗 A group of population criteria for the measure.Measure.group(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< An identifier that is unique within the Measure allowing linkage to the equivalent item in a MeasureReport resource. This ''can'' be a meaningful identifier (e.g. a LOINC code) but is not intended to have any meaning. GUIDs or sequential numbers are appropriate here.
LinkIds can have whitespaces and slashes by design. Tooling should not rely on linkIds being valid XHTML element IDs, and should not directly embed them as such; (xsd)linkId:string>?
< Indicates a meaning for the group. This can be as simple as a unique identifier, or it can establish meaning in a broader context by drawing from a terminology, allowing groups to be correlated across measures. Binding: measure-group-example (example, Example of measure groups.); (xsd)code:CodeableConcept>?
< The human readable description of this population group.; (xsd)description:markdown>?
[]< Indicates whether the measure is used to examine a process, an outcome over time, a patient-reported outcome, or a structure measure such as utilization. When specified at the group level, defines the measure type for this specific group. If not specified, the measureType of the group is determined by the root type element Binding: measure-type (extensible, ); (xsd)type:CodeableConcept>*
< The intended subjects for the measure. If this element is not provided, a Patient subject is assumed, but the subject of the measure can be anything. The subject of the measure is critical in interpreting the criteria definitions, as the logic in the measures is evaluated with respect to a particular subject. This corresponds roughly to the notion of a Compartment in that it limits what content is available based on its relationship to the subject. In CQL, this corresponds to the context declaration. Binding: participant-resource-types (extensible, The possible types of subjects for a measure (E.g. Patient, Practitioner, Organization, Location, etc.).); (xsd)subject:(<CodeableConcept>
|<Group>)>?
< The population basis specifies the type of elements in the population. For a subject-based measure, this is boolean (because the subject and the population basis are the same, and the population criteria define yes/no values for each individual in the population). For measures that have a population basis that is different than the subject, this element specifies the type of the population basis. For example, an encounter-based measure has a subject of Patient and a population basis of Encounter, and the population criteria all return lists of Encounters. When specified at the group level, defines the population basis for this specific group. If not specified, the basis for the group is determined by the root basis element Binding: fhir-types (required, ); (xsd)basis:code>?
< Indicates how the calculation is performed for the measure, including proportion, ratio, continuous-variable, and cohort. The value set is extensible, allowing additional measure scoring types to be represented. When specified at the group level, defines the scoring for this specific group. If not specified, scoring for this group is determined by the root scoring element Binding: http://terminology.hl7.org/ValueSet/measure-scoring (extensible, ); (xsd)scoring:CodeableConcept>?
< Defines the expected units of measure for the measure score. This element SHOULD be specified as a UCUM unit. When specified at the group level, this defines the scoringUnit for this specific group. If not specified, the scoringUnit for this group is determined by the root scoringUnit element. As with the root element, when this element is specified, implementations are expected to report measure scores in the specified units. Note that this may involve unit conversion if the expected units are different than the units of the resulting score calculation. In this case, unit conversions SHALL be performed according to the unit conversion semantics specified by UCUM. Binding: measure-scoring-unit (example, ); (xsd)scoringUnit:CodeableConcept>?
< Describes how to combine the information calculated, based on logic in each of several populations, into one summarized result. The measure rate for an organization or clinician is based upon the entities’ aggregate data and summarizes the performance of the entity over a given time period (e.g., monthly, quarterly, yearly). The aggregated data are derived from the results of a specific measure algorithm and, if appropriate, the application of specific risk adjustment models. Can also be used to describe how to risk adjust the data based on supplemental data elements described in the eMeasure (e.g., pneumonia hospital measures antibiotic selection in the ICU versus non-ICU and then the roll-up of the two). This could be applied to aggregated cohort measure definitions (e.g., CDC's aggregate reporting for TB at the state level).; (xsd)rateAggregation:markdown>?
< Information on whether an increase or decrease in score is the preferred result (e.g., a higher score indicates better quality OR a lower score indicates better quality OR quality is within a range). When specified at the group level, this element defines the improvementNotation for this specific group. If not specified, improvementNotation for this group is determined by the root improvementNotation element Binding: measure-improvement-notation (required, ); (xsd)improvementNotation:CodeableConcept>?
[]< A reference to a Library resource containing the formal logic used by the measure group.; (xsd)library:Library*>*
[]< A population criteria for the measure.; (xsd)population:Measure.group.population>*
[]< The stratifier criteria for the measure report, specified as either the name of a valid CQL expression defined within a referenced library or a valid FHIR Resource Path.; (xsd)stratifier:Measure.group.stratifier>*🔗 A population criteria for the measure.Measure.group.population(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< An identifier that is unique within the Measure allowing linkage to the equivalent population in a MeasureReport resource. This ''can'' be a meaningful identifier (e.g. a LOINC code) but is not intended to have any meaning. GUIDs or sequential numbers are appropriate here.
LinkIds can have whitespaces and slashes by design. Tooling should not rely on linkIds being valid XHTML element IDs, and should not directly embed them as such; (xsd)linkId:string>?
< The type of population criteria. Binding: measure-population (extensible, The type of population.); (xsd)code:CodeableConcept>?
< The human readable description of this population criteria.; (xsd)description:markdown>?
< An expression that specifies the criteria for the population, typically the name of an expression in a library. In the case of a continuous-variable or ratio measure, this may be the name of a function that calculates the value of the individual observation for each patient or event in the population. For these types of measures, individual observations are reported as observation resources included in the evaluatedResources bundle for each patient. See the MeasureReport resource or the Quality Reporting topic for more information.; (xsd)criteria:Expression>?
< A Group resource that defines this population as a set of characteristics. Note that this approach can only be used for measures where the basis is of the same type as the populations (e.g. a Patient-based measure, rather than an Encounter-based measure). In addition, the referenced Group resource SHALL be a definitional (as opposed to an actual) group.; (xsd)groupDefinition:Group*>?
< The id of a population element in this measure that provides the input for this population criteria. In most cases, the scoring structure of the measure implies specific relationships (e.g. the Numerator uses the Denominator as the source in a proportion scoring). In some cases, however, multiple possible choices exist and must be resolved explicitly. For example in a ratio measure with multiple initial populations, the denominator must specify which population should be used as the starting point.; (xsd)inputPopulationId:string>?
< Specifies which method should be used to aggregate measure observation values. For most scoring types, this is implied by scoring (e.g. a proportion measure counts members of the populations). For continuous variables, however, this information must be specified to ensure correct calculation. Binding: measure-aggregate-method (extensible, ); (xsd)aggregateMethod:CodeableConcept>?🔗 The stratifier criteria for the measure report, specified as either the name of a valid CQL expression defined within a referenced library or a valid FHIR Resource Path.Measure.group.stratifier(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< An identifier that is unique within the Measure allowing linkage to the equivalent item in a MeasureReport resource. This ''can'' be a meaningful identifier (e.g. a LOINC code) but is not intended to have any meaning. GUIDs or sequential numbers are appropriate here.
LinkIds can have whitespaces and slashes by design. Tooling should not rely on linkIds being valid XHTML element IDs, and should not directly embed them as such; (xsd)linkId:string>?
< Indicates a meaning for the stratifier. This can be as simple as a unique identifier, or it can establish meaning in a broader context by drawing from a terminology, allowing stratifiers to be correlated across measures. Binding: measure-stratifier-example (example, Meaning of the stratifier.); (xsd)code:CodeableConcept>?
< The human readable description of this stratifier criteria.; (xsd)description:markdown>?
< An expression that specifies the criteria for the stratifier. This is typically the name of an expression defined within a referenced library, but it may also be a path to a stratifier element.; (xsd)criteria:Expression>?
< A Group resource that defines this population as a set of characteristics. Note that this approach can only be used for measures where the basis is of the same type as the populations (e.g. a Patient-based measure, rather than an Encounter-based measure). In addition, the referenced Group SHALL be a definitional (as opposed to an actual) group.; (xsd)groupDefinition:Group*>?
[]< A component of the stratifier criteria for the measure report, specified as either the name of a valid CQL expression defined within a referenced library or a valid FHIR Resource Path. Stratifiers are defined either as a single criteria, or as a set of component criteria.; (xsd)component:Measure.group.stratifier.component>*🔗 A component of the stratifier criteria for the measure report, specified as either the name of a valid CQL expression defined within a referenced library or a valid FHIR Resource Path. Stratifiers are defined either as a single criteria, or as a set of component criteria.Measure.group.stratifier.component(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< An identifier that is unique within the Measure allowing linkage to the equivalent item in a MeasureReport resource. This ''can'' be a meaningful identifier (e.g. a LOINC code) but is not intended to have any meaning. GUIDs or sequential numbers are appropriate here.
LinkIds can have whitespaces and slashes by design. Tooling should not rely on linkIds being valid XHTML element IDs, and should not directly embed them as such; (xsd)linkId:string>?
< Indicates a meaning for the stratifier component. This can be as simple as a unique identifier, or it can establish meaning in a broader context by drawing from a terminology, allowing stratifiers to be correlated across measures. Binding: measure-stratifier-example (example, Meaning of the stratifier.); (xsd)code:CodeableConcept>?
< The human readable description of this stratifier criteria component.; (xsd)description:markdown>?
< An expression that specifies the criteria for this component of the stratifier. This is typically the name of an expression defined within a referenced library, but it may also be a path to a stratifier element.; (xsd)criteria:Expression>?
< A Group resource that defines this population as a set of characteristics. Note that this approach can only be used for measures where the basis is of the same type as the populations (e.g. a Patient-based measure, rather than an Encounter-based measure). In addition, the referenced Group SHALL be a definitional (as opposed to an actual) group.; (xsd)groupDefinition:Group*>?🔗 The supplemental data criteria for the measure report, specified as either the name of a valid CQL expression within a referenced library, or a valid FHIR Resource Path. Note that supplemental data are reported as resources for each patient and referenced in the supplementalData element of the MeasureReport. If the supplementalData expression results in a value other than a resource, it is reported using an Observation resource, typically contained in the resulting MeasureReport. See the MeasureReport resource and the Quality Reporting topic for more information.Measure.supplementalData(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< An identifier that is unique within the Measure allowing linkage to the equivalent item in a MeasureReport resource. This ''can'' be a meaningful identifier (e.g. a LOINC code) but is not intended to have any meaning. GUIDs or sequential numbers are appropriate here.
LinkIds can have whitespaces and slashes by design. Tooling should not rely on linkIds being valid XHTML element IDs, and should not directly embed them as such; (xsd)linkId:string>?
< Indicates a meaning for the supplemental data. This can be as simple as a unique identifier, or it can establish meaning in a broader context by drawing from a terminology, allowing supplemental data to be correlated across measures. Binding: measure-supplemental-data-example (example, Meaning of the supplemental data.); (xsd)code:CodeableConcept>?
[]< An indicator of the intended usage for the supplemental data element. Supplemental data indicates the data is additional information requested to augment the measure information. Risk adjustment factor indicates the data is additional information used to calculate risk adjustment factors when applying a risk model to the measure calculation. Binding: measure-data-usage (extensible, The intended usage for supplemental data elements in the measure.); (xsd)usage:CodeableConcept>*
< The human readable description of this supplemental data.; (xsd)description:markdown>?
< The criteria for the supplemental data. This is typically the name of a valid expression defined within a referenced library, but it may also be a path to a specific data element. The criteria defines the data to be returned for this element.; (xsd)criteria:Expression>🔗 Provides a description of an individual term used within the measure.Measure.term(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A codeable representation of the defined term. Binding: measure-definition-example (example, Codeable representations of measure definition terms.); (xsd)code:CodeableConcept>?
< Provides a definition for the term as used within the measure.; (xsd)definition:markdown>?🔗 The MeasureReport resource contains the results of the calculation of a measure; and optionally a reference to the resources involved in that calculation.MeasureReport(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< A formal identifier that is used to identify this MeasureReport when it is represented in other formats or referenced in a specification, model, design or an instance. Typically, this is used for identifiers that can go in an HL7 V3 II data type - e.g. to identify this {{title}} outside of FHIR, where the logical URL is not possible to use.; (xsd)identifier:Identifier>*
< The MeasureReport status. No data will be available until the MeasureReport status is complete. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. Binding: measure-report-status (required, The status of the measure report (e.g. complete, pending, or error)); (xsd)status:code>
< The type of measure report. This may be an individual report, which provides the score for the measure for an individual member of the population; a subject-listing, which returns the list of members that meet the various criteria in the measure; a summary report, which returns a population count for each of the criteria in the measure; or a data-collection, which enables the MeasureReport to be used to exchange the data-of-interest for a quality measure. Data-exchange reports are used only to communicate data-of-interest for a measure. They do not necessarily include all the data for a particular subject or population, but they may. Binding: measure-report-type (required, The type of the measure report: individual, patient listing, or summary); (xsd)type:code>
< Indicates whether the data submitted in a data-exchange report represents a snapshot or incremental update. A snapshot update replaces all previously submitted data for the receiver, whereas an incremental update represents only updated and/or changed data and should be applied as a differential update to the existing submitted data for the receiver. This element only applies to Data-collection reports used to communicate the data-of-interest for a measure Binding: submit-data-update-type (required, ); (xsd)dataUpdateType:code>?
< A reference to the Measure that was calculated to produce this report.; (xsd)measure:Measure*>?
< Optional subject identifying the individual or individuals the report is for.; (xsd)subject:(<CareTeam>
|<Device>
|<Group>
|<HealthcareService>
|<Location>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>?
< The date this measure was calculated.; (xsd)date:dateTime>?
< The individual or organization that is reporting the data.; (xsd)reporter:(<Group>
|<Organization>
|<Practitioner>
|<PractitionerRole>)>?
< A reference to the vendor who queried the data, calculated results and/or generated the report. The ‘reporting vendor’ is intended to represent the submitting entity when it is not the same as the reporting entity. This extension is used when the Receiver is interested in getting vendor information in the report.; (xsd)reportingVendor:Organization*>?
< A reference to the location for which the data is being reported.; (xsd)location:Location*>?
< The reporting period for which the report was calculated.; (xsd)period:Period>
< A reference to a Parameters resource (typically represented using a contained resource) that represents any input parameters that were provided to the operation that generated the report. Whenever an operation returns a MeasureReport, the IN parameters from that operation can be returned to the caller of the operation using MeasureReport.inputParameters. Operations include but are not limited to $evaluate-measure, $care-gaps, $data-requirements, and $collect-data. The inputParameters can also be used in a MeasureReport used to define a test case (i.e., not as a result of an operation).; (xsd)inputParameters:Parameters*>?
< Indicates how the calculation is performed for the measure, including proportion, ratio, continuous-variable, and cohort. The value set is extensible, allowing additional measure scoring types to be represented. It is expected to be the same as the scoring element on the referenced Measure. Binding: http://terminology.hl7.org/ValueSet/measure-scoring (extensible, ); (xsd)scoring:CodeableConcept>?
< Whether improvement in the measure is noted by an increase or decrease in the measure score. This element is typically defined by the measure, but reproduced here to ensure the measure score can be interpreted. The element is labeled as a modifier because it changes the interpretation of the reported measure score. Note also that a MeasureReport instance includes the improvementNotation as defined by the Measure being reported. It is duplicated in the MeasureReport because it is a critical aspect of interpreting the measure score but it is not intended to reflect whether the measure report is an increase or decrease. It helps interpret if the measure score is an increase or decrease, I.e., moving in the direction of the desired outcome. Binding: measure-improvement-notation (required, The improvement notation of the measure report (e.g. increase or decrease)); (xsd)improvementNotation:CodeableConcept>?
[]< The results of the calculation, one for each population group in the measure.; (xsd)group:MeasureReport.group>*
[]< A reference to a Resource that represents additional information collected for the report. If the value of the supplemental data is not a Resource (i.e. evaluating the supplementalData expression for this case in the measure results in a value that is not a FHIR Resource), it is reported as a reference to a contained Observation resource. For individual measure reports, the supplementalData elements represent the direct result of evaluating the supplementalData expression for the subject of the report. For summary reports, supplementalData is reported as references to contained Observation resources that represent the number of times each value appeared as a supplementalData result for members of the population.; (xsd)supplementalData:Resource*>*
[]< Evaluated resources are used to capture what data was involved in the calculation of a measure. This usage is only allowed for individual reports to ensure that the size of the MeasureReport resource is bounded. Evaluated resources are only reported for individual reports.; (xsd)evaluatedResource:Resource*>*🔗 The results of the calculation, one for each population group in the measure.MeasureReport.group(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The group from the Measure that corresponds to this group in the MeasureReport resource.; (xsd)linkId:string>?
< The meaning of the population group as defined in the measure definition. Binding: measure-group-example (example, Example of measure groups.); (xsd)code:CodeableConcept>?
< Optional subject identifying the individual or individuals the report is for.; (xsd)subject:(<CareTeam>
|<Device>
|<Group>
|<HealthcareService>
|<Location>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>?
[]< The populations that make up the population group, one for each type of population appropriate for the measure.; (xsd)population:MeasureReport.group.population>*
< The measure score for this population group, calculated as appropriate for the measure type and scoring method, and based on the contents of the populations defined in the group.; (xsd)measureScore:(<CodeableConcept>
|<dateTime>
|<Duration>
|<Period>
|<Quantity>
|<Range>)>?
[]< When a measure includes multiple stratifiers, there will be a stratifier group for each stratifier defined by the measure.; (xsd)stratifier:MeasureReport.group.stratifier>*🔗 The populations that make up the population group, one for each type of population appropriate for the measure.MeasureReport.group.population(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The population from the Measure that corresponds to this population in the MeasureReport resource.; (xsd)linkId:string>?
< The type of the population. Binding: measure-population (extensible, The type of population (e.g. initial, numerator, denominator, etc.).); (xsd)code:CodeableConcept>?
< The number of members of the population.; (xsd)count:integer>?
< This element refers to a List of individual level MeasureReport resources, one for each subject in this population.; (xsd)subjectResults:List*>?
[]< A reference to an individual level MeasureReport resource for a member of the population. This element SHALL NOT be used in with subjectResults, either systems provide results as a List of MeasureReport, or as references to individual MeasureReports. Note that using this element introduces a constraint on the size of the subject-list MeasureReport; implementations would be free to return a TOO-COSTLY response if a request is made for a subject-list report with too many subjects.; (xsd)subjectReport:MeasureReport*>*
< Optional Group identifying the individuals that make up the population. Note that this element can only be used for summary and subject-list reports where the basis is of the same type as the populations (e.g. a Patient-based measure, rather than an Encounter-based measure). In addition, the referenced Group resource SHALL be an actual (as opposed to a definitional) group.; (xsd)subjects:Group*>?🔗 When a measure includes multiple stratifiers, there will be a stratifier group for each stratifier defined by the measure.MeasureReport.group.stratifier(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The stratifier from the Measure that corresponds to this stratifier in the MeasureReport resource.; (xsd)linkId:string>?
< The meaning of this stratifier, as defined in the measure definition. Binding: measure-stratifier-example (example, Meaning of the stratifier.); (xsd)code:CodeableConcept>?
[]< This element contains the results for a single stratum within the stratifier. For example, when stratifying on administrative gender, there will be four strata, one for each possible gender value.; (xsd)stratum:MeasureReport.group.stratifier.stratum>*🔗 This element contains the results for a single stratum within the stratifier. For example, when stratifying on administrative gender, there will be four strata, one for each possible gender value.MeasureReport.group.stratifier.stratum(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
(<valueBoolean:boolean>
|<valueCodeableConcept:CodeableConcept>
|<valueQuantity:Quantity>
|<valueRange:Range>
|<valueResource:Resource>)?
[]< A stratifier component value.; (xsd)component:MeasureReport.group.stratifier.stratum.component>*
[]< The populations that make up the stratum, one for each type of population appropriate to the measure.; (xsd)population:MeasureReport.group.stratifier.stratum.population>*
< The measure score for this stratum, calculated as appropriate for the measure type and scoring method, and based on only the members of this stratum.; (xsd)measureScore:(<CodeableConcept>
|<dateTime>
|<Duration>
|<Period>
|<Quantity>
|<Range>)>?🔗 A stratifier component value.MeasureReport.group.stratifier.stratum.component(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The stratifier component from the Measure that corresponds to this stratifier component in the MeasureReport resource.; (xsd)linkId:string>?
< The code for the stratum component value. Binding: measure-stratifier-example (example, Meaning of the stratifier.); (xsd)code:CodeableConcept>
(<valueBoolean:boolean>
|<valueCodeableConcept:CodeableConcept>
|<valueQuantity:Quantity>
|<valueRange:Range>
|<valueResource:Resource>)🔗 The populations that make up the stratum, one for each type of population appropriate to the measure.MeasureReport.group.stratifier.stratum.population(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The population from the Measure that corresponds to this population in the MeasureReport resource.; (xsd)linkId:string>?
< The type of the population. Binding: measure-population (extensible, The type of population (e.g. initial, numerator, denominator, etc.).); (xsd)code:CodeableConcept>?
< The number of members of the population in this stratum.; (xsd)count:integer>?
< This element refers to a List of individual level MeasureReport resources, one for each subject in this population in this stratum.; (xsd)subjectResults:List*>?
[]< A reference to an individual level MeasureReport resource for a member of the population. This element SHALL NOT be used in with subjectResults, either systems provide results as a List of MeasureReport, or as references to individual MeasureReports. Note that using this element introduces a constraint on the size of the subject-list MeasureReport; implementations would be free to return a TOO-COSTLY response if a request is made for a subject-list report with too many subjects.; (xsd)subjectReport:MeasureReport*>*
< Optional Group identifying the individuals that make up the population. Note that this element can only be used for summary and subject-list reports where the basis is of the same type as the populations (e.g. a Patient-based measure, rather than an Encounter-based measure). In addition, the referenced Group SHALL be an actual (as opposed to a definitional) group.; (xsd)subjects:Group*>?🔗 This resource is primarily used for the identification and definition of a medication, including ingredients, for the purposes of prescribing, dispensing, and administering a medication as well as for making statements about medication use.Medication(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< Business identifier for this medication. The serial number could be included as an identifier.; (xsd)identifier:Identifier>*
< A code (or set of codes) that specify this medication, or a textual description if no code is available. Usage note: This could be a standard medication code such as a code from RxNorm, SNOMED CT, IDMP etc. It could also be a national or local formulary code, optionally with translations to other code systems. Depending on the context of use, the code that was actually selected by the user (prescriber, dispenser, etc.) will have the coding.userSelected set to true. As described in the coding datatype: "A coding may be marked as a "userSelected" if a user selected the particular coded value in a user interface (e.g. the user selects an item in a pick-list). If a user selected coding exists, it is the preferred choice for performing translations etc. Other codes can only be literal translations to alternative code systems, or codes at a lower level of granularity (e.g. a generic code for a vendor-specific primary one). Binding: medication-codes (example, A coded concept that defines the type of a medication.); (xsd)code:CodeableConcept>?
< A code to indicate if the medication is in active use. This status is intended to identify if the medication in a local system is in active use within a drug database or inventory. For example, a pharmacy system may create a new drug file record for a compounded product "ABC Hospital Special Cream" with an active status. At some point in the future, it may be determined that the drug record was created with an error and the status is changed to "entered in error". This status is not intended to specify if a medication is part of a particular formulary. It is possible that the drug record may be referenced by multiple formularies or catalogues and each of those entries would have a separate status. Binding: medication-status (required, A coded concept defining if the medication is in active use.); (xsd)status:code>?
< The company or other legal entity that has authorization, from the appropriate drug regulatory authority, to market a medicine in one or more jurisdictions. Typically abbreviated MAH.Note: The MAH may manufacture the product and may also contract the manufacturing of the product to one or more companies (organizations).; (xsd)marketingAuthorizationHolder:Organization*>?
< Describes the form of the item. Powder; tablets; capsule. When Medication is referenced from MedicationRequest, this is the ordered form. When Medication is referenced within MedicationDispense, this is the dispensed form. When Medication is referenced within MedicationAdministration, this is administered form. Binding: medication-form-codes (example, A coded concept defining the form of a medication.); (xsd)doseForm:CodeableConcept>?
< When the specified product code does not infer a package size, this is the specific amount of drug in the product. For example, when specifying a product that has the same strength (For example, Insulin glargine 100 unit per mL solution for injection), this attribute provides additional clarification of the package amount (For example, 3 mL, 10mL, etc.).; (xsd)totalVolume:Quantity>?
[]< Identifies a particular constituent of interest in the product. The ingredients need not be a complete list. If an ingredient is not specified, this does not indicate whether an ingredient is present or absent. If an ingredient is specified it does not mean that all ingredients are specified. It is possible to specify both inactive and active ingredients.; (xsd)ingredient:Medication.ingredient>*
< Information that only applies to packages (not products).; (xsd)batch:Medication.batch>?
< A reference to a knowledge resource that provides more information about this medication.; (xsd)definition:MedicationKnowledge*>?🔗 Information that only applies to packages (not products).Medication.batch(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The assigned lot number of a batch of the specified product.; (xsd)lotNumber:string>?
< When this specific batch of product will expire.; (xsd)expirationDate:dateTime>?🔗 Identifies a particular constituent of interest in the product. The ingredients need not be a complete list. If an ingredient is not specified, this does not indicate whether an ingredient is present or absent. If an ingredient is specified it does not mean that all ingredients are specified. It is possible to specify both inactive and active ingredients.Medication.ingredient(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The ingredient (substance or medication) that the ingredient.strength relates to. This is represented as a concept from a code system or described in another resource (Substance or Medication). Binding: medication-codes (example, ); (xsd)item:(<Medication>
|<Substance>)>
< Indication of whether this ingredient affects the therapeutic action of the drug.; (xsd)isActive:boolean>?
< Specifies how many (or how much) of the items there are in this Medication. For example, 250 mg per tablet. This is expressed as a ratio where the numerator is 250mg and the denominator is 1 tablet but can also be expressed a quantity when the denominator is assumed to be 1 tablet. Binding: medication-ingredientstrength (preferred, A coded concpet defining the strength of an ingredient.); (xsd)strength:(<CodeableConcept>
|<Quantity>
|<Ratio>)>?🔗 Describes the event of a patient consuming or otherwise being administered a medication. This may be as simple as swallowing a tablet or it may be a long running infusion. Related resources tie this event to the authorizing prescription, and the specific encounter between patient and health care practitioner.MedicationAdministration(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< Identifiers associated with this Medication Administration that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server. This is a business identifier, not a resource identifier.; (xsd)identifier:Identifier>*
[]< A plan that is fulfilled in whole or in part by this MedicationAdministration.; (xsd)basedOn:CarePlan*>*
[]< A larger event of which this particular event is a component or step. MedicationDispense will be used to indicate waste.; (xsd)partOf:(<MedicationAdministration>
|<MedicationDispense>
|<Procedure>)>*
< Will generally be set to show that the administration has been completed. For some long running administrations such as infusions, it is possible for an administration to be started but not completed or it may be paused while some other process is under way. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. Binding: medication-admin-status (required, A set of codes indicating the current status of a MedicationAdministration.); (xsd)status:code>
[]< A code indicating why the administration was not performed. Binding: reason-medication-not-given-codes (example, A set of codes indicating the reason why the MedicationAdministration is negated.); (xsd)statusReason:CodeableConcept>*
[]< The type of medication administration (for example, drug classification like ATC, where meds would be administered, legal category of the medication). Binding: medication-admin-location (example, A coded concept describing where the medication administered is expected to occur.); (xsd)category:CodeableConcept>*
< Identifies the medication that was administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications. If only a code is specified, then it needs to be a code for a specific product. If more information is required, then the use of the medication resource is recommended. For example, if you require form or lot number, then you must reference the Medication resource. Binding: medication-codes (example, Codes identifying substance or product that can be administered.); (xsd)medication:Medication*>
< The person or animal or group receiving the medication.; (xsd)subject:(<Group>
|<Patient>)>
< The visit, admission, or other contact between patient and health care provider during which the medication administration was performed.; (xsd)encounter:Encounter*>?
[]< Additional information (for example, patient height and weight) that supports the administration of the medication. This attribute can be used to provide documentation of specific characteristics of the patient present at the time of administration. For example, if the dose says "give "x" if the heartrate exceeds "y"", then the heart rate can be included using this attribute.; (xsd)supportingInformation:Resource*>*
< A specific date/time or interval of time during which the administration took place (or did not take place). For many administrations, such as swallowing a tablet the use of dateTime is more appropriate.; (xsd)occurence:(<dateTime>
|<Period>
|<Timing>)>
< The date the occurrence of the MedicationAdministration was first captured in the record - potentially significantly after the occurrence of the event.; (xsd)recorded:dateTime>?
< An indication that the full dose was not administered.; (xsd)isSubPotent:boolean>?
[]< The reason or reasons why the full dose was not administered. Binding: administration-subpotent-reason (example, ); (xsd)subPotentReason:CodeableConcept>*
[]< The performer of the medication treatment. For devices this is the device that performed the administration of the medication. An IV Pump would be an example of a device that is performing the administration. Both the IV Pump and the practitioner that set the rate or bolus on the pump can be listed as performers.; (xsd)performer:MedicationAdministration.performer>*
[]< A code, Condition or observation that supports why the medication was administered. Binding: reason-medication-given-codes (example, A set of codes indicating the reason why the MedicationAdministration was made.); (xsd)reason:(<Condition>
|<DiagnosticReport>
|<Observation>)>*
< The original request, instruction or authority to perform the administration. This is a reference to the MedicationRequest where the intent is either order or instance-order. It should not reference MedicationRequests where the intent is any other value.; (xsd)request:MedicationRequest*>?
[]< The device that is to be used for the administration of the medication (for example, PCA Pump).; (xsd)device:Device*>*
[]< Extra information about the medication administration that is not conveyed by the other attributes.; (xsd)note:Annotation>*
< Describes the medication dosage information details e.g. dose, rate, site, route, etc.; (xsd)dosage:MedicationAdministration.dosage>?
[]< A summary of the events of interest that have occurred, such as when the administration was verified. This might not include provenances for all versions of the request – only those deemed “relevant” or important. This SHALL NOT include the Provenance associated with this current version of the resource. (If that provenance is deemed to be a “relevant” change, it will need to be added as part of a later update. Until then, it can be queried directly as the Provenance that points to this version using _revinclude All Provenances should have some historical version of this Request as their subject.; (xsd)eventHistory:Provenance*>*🔗 Describes the medication dosage information details e.g. dose, rate, site, route, etc.MedicationAdministration.dosage(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Free text dosage can be used for cases where the dosage administered is too complex to code. When coded dosage is present, the free text dosage may still be present for display to humans.
The dosage instructions should reflect the dosage of the medication that was administered.; (xsd)text:string>?
< A coded specification of the anatomic site where the medication first entered the body. For example, "left arm". If the use case requires attributes from the BodySite resource (e.g. to identify and track separately) then use the standard extension [http://hl7.org/fhir/StructureDefinition/bodySite](http://hl7.org/fhir/extensions/StructureDefinition-bodySite.html). May be a summary code, or a reference to a very precise definition of the location, or both. Binding: approach-site-codes (example, A coded concept describing the site location the medicine enters into or onto the body.); (xsd)site:CodeableConcept>?
< A code specifying the route or physiological path of administration of a therapeutic agent into or onto the patient. For example, topical, intravenous, etc. Binding: route-codes (example, A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.); (xsd)route:CodeableConcept>?
< A coded value indicating the method by which the medication is intended to be or was introduced into or on the body. This attribute will most often NOT be populated. It is most commonly used for injections. For example, Slow Push, Deep IV. One of the reasons this attribute is not used often, is that the method is often pre-coordinated with the route and/or form of administration. This means the codes used in route or form may pre-coordinate the method in the route code or the form code. The implementation decision about what coding system to use for route or form code will determine how frequently the method code will be populated e.g. if route or form code pre-coordinate method code, then this attribute will not be populated often; if there is no pre-coordination then method code may be used frequently. Binding: administration-method-codes (example, A coded concept describing the technique by which the medicine is administered.); (xsd)method:CodeableConcept>?
< The amount of the medication given at one administration event. Use this value when the administration is essentially an instantaneous event such as a swallowing a tablet or giving an injection. If the administration is not instantaneous (rate is present), this can be specified to convey the total amount administered over period of time of a single administration.; (xsd)dose:SimpleQuantity>?
< Identifies the speed with which the medication was or will be introduced into the patient. Typically, the rate for an infusion e.g. 100 ml per 1 hour or 100 ml/hr. May also be expressed as a rate per unit of time, e.g. 500 ml per 2 hours. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours. If the rate changes over time, and you want to capture this in MedicationAdministration, then each change should be captured as a distinct MedicationAdministration, with a specific MedicationAdministration.dosage.rate, and the date time when the rate change occurred. Typically, the MedicationAdministration.dosage.rate element is not used to convey an average rate.; (xsd)rate:(<Ratio>
|<SimpleQuantity>)>?🔗 The performer of the medication treatment. For devices this is the device that performed the administration of the medication. An IV Pump would be an example of a device that is performing the administration. Both the IV Pump and the practitioner that set the rate or bolus on the pump can be listed as performers.MedicationAdministration.performer(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Distinguishes the type of involvement of the performer in the medication administration. Binding: med-admin-perform-function (example, A code describing the role an individual played in administering the medication.); (xsd)function:CodeableConcept>?
< Indicates who or what performed the medication administration.; (xsd)actor:(<Device>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>🔗 Indicates that a medication product is to be or has been dispensed for a named person/patient. This includes a description of the medication product (supply) provided and the instructions for administering the medication. The medication dispense is the result of a pharmacy system responding to a medication order.MedicationDispense(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< Identifiers associated with this Medication Dispense that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server. This is a business identifier, not a resource identifier.; (xsd)identifier:Identifier>*
[]< A plan that is fulfilled in whole or in part by this MedicationDispense.; (xsd)basedOn:CarePlan*>*
[]< The procedure or medication administration that triggered the dispense. While both a procedure and a medication administration may have triggered the dispense, but it is not expected that multiple procedures and/or multiple medication administrations would be triggers.; (xsd)partOf:(<MedicationAdministration>
|<Procedure>)>*
< A code specifying the state of the set of dispense events. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. Binding: medicationdispense-status (required, Describes the lifecycle of the dispense.); (xsd)status:code>
< Indicates the reason why a dispense was not performed. Binding: medicationdispense-status-reason (example, ); (xsd)notPerformedReason:DetectedIssue*>?
< The date (and maybe time) when the status of the dispense record changed.; (xsd)statusChanged:dateTime>?
[]< Indicates the type of medication dispense (for example, drug classification like ATC, where meds would be administered, legal category of the medication.). The category can be used to include where the medication is expected to be consumed or other types of dispenses. Invariants can be used to bind to different value sets when profiling to bind. Binding: medicationdispense-admin-location (example, A code describing where the dispensed medication is expected to be consumed or administered.); (xsd)category:CodeableConcept>*
< Identifies the medication supplied. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications. If only a code is specified, then it needs to be a code for a specific product. If more information is required, then the use of the medication resource is recommended. For example, if you require form or lot number, then you must reference the Medication resource. Binding: medication-codes (example, A coded concept identifying which substance or product can be dispensed.); (xsd)medication:Medication*>
< A link to a resource representing the person or the group to whom the medication will be given. SubstanceAdministration->subject->Patient.; (xsd)subject:(<Group>
|<Patient>)>
< The encounter that establishes the context for this event.; (xsd)encounter:Encounter*>?
[]< Additional information that supports the medication being dispensed. For example, there may be requirements that a specific lab test has been completed prior to dispensing or the patient's weight at the time of dispensing is documented.; (xsd)supportingInformation:Resource*>*
[]< Indicates who or what performed the event.; (xsd)performer:MedicationDispense.performer>*
< The principal physical location where the dispense was performed.; (xsd)location:Location*>?
[]< Indicates the medication order that is being dispensed against. Maps to basedOn in Event logical model.; (xsd)authorizingPrescription:MedicationRequest*>*
< Indicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc. Binding: http://terminology.hl7.org/ValueSet/v3-ActPharmacySupplyType (example, ActPharmacySupplyType ); (xsd)type:CodeableConcept>?
< The amount of medication that has been dispensed. Includes unit of measure.; (xsd)quantity:SimpleQuantity>?
< The amount of medication expressed as a timing amount.; (xsd)daysSupply:SimpleQuantity>?
< The date (and maybe time) when the dispense activity started if whenPrepared or whenHandedOver is not populated.; (xsd)recorded:dateTime>?
< The time when the dispensed product was packaged and reviewed.; (xsd)whenPrepared:dateTime>?
< The time the dispensed product was provided to the patient or their representative.; (xsd)whenHandedOver:dateTime>?
< Identification of the facility/location where the medication was/will be shipped to, as part of the dispense event.; (xsd)destination:Location*>?
[]< Identifies the person who picked up the medication or the location of where the medication was delivered. This will usually be a patient or their caregiver, but some cases exist where it can be a healthcare professional or a location.; (xsd)receiver:(<Location>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>*
[]< Extra information about the dispense that could not be conveyed in the other attributes.; (xsd)note:Annotation>*
< The full representation of the dose of the medication included in all dosage instructions. To be used when multiple dosage instructions are included to represent complex dosing such as increasing or tapering doses. The content of the renderedDosageInstructions must not be different than the dose represented in the dosageInstruction content.; (xsd)renderedDosageInstruction:markdown>?
[]< Indicates how the medication is to be used by the patient. When the dose or rate is intended to change over the entire administration period (e.g. Tapering dose prescriptions), multiple instances of dosage instructions will need to be supplied to convey the different doses/rates.
The pharmacist reviews the medication order prior to dispense and updates the dosageInstruction based on the actual product being dispensed.; (xsd)dosageInstruction:Dosage>*
< Indicates whether or not substitution was made as part of the dispense. In some cases, substitution will be expected but does not happen, in other cases substitution is not expected but does happen. This block explains what substitution did or did not happen and why. If nothing is specified, substitution was not done.; (xsd)substitution:MedicationDispense.substitution>?
[]< A summary of the events of interest that have occurred, such as when the dispense was verified. This might not include provenances for all versions of the request – only those deemed “relevant” or important. This SHALL NOT include the Provenance associated with this current version of the resource. (If that provenance is deemed to be a “relevant” change, it will need to be added as part of a later update. Until then, it can be queried directly as the Provenance that points to this version using _revinclude All Provenances should have some historical version of this Request as their subject.).; (xsd)eventHistory:Provenance*>*🔗 Indicates who or what performed the event.MedicationDispense.performer(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Distinguishes the type of performer in the dispense. For example, date enterer, packager, final checker. Binding: medicationdispense-performer-function (example, A code describing the role an individual played in dispensing a medication.); (xsd)function:CodeableConcept>?
< The device, practitioner, etc. who performed the action. It should be assumed that the actor is the dispenser of the medication.; (xsd)actor:(<CareTeam>
|<Device>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>🔗 Indicates whether or not substitution was made as part of the dispense. In some cases, substitution will be expected but does not happen, in other cases substitution is not expected but does happen. This block explains what substitution did or did not happen and why. If nothing is specified, substitution was not done.MedicationDispense.substitution(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< True if the dispenser dispensed a different drug or product from what was prescribed.; (xsd)wasSubstituted:boolean>
< A code signifying whether a different drug was dispensed from what was prescribed. Binding: http://terminology.hl7.org/ValueSet/v3-ActSubstanceAdminSubstitutionCode (example, ActSubstanceAdminSubstitutionCode); (xsd)type:CodeableConcept>?
[]< Indicates the reason for the substitution (or lack of substitution) from what was prescribed. Binding: http://terminology.hl7.org/ValueSet/v3-SubstanceAdminSubstitutionReason (example, SubstanceAdminSubstitutionReason); (xsd)reason:CodeableConcept>*
< The person or organization that has primary responsibility for the substitution.; (xsd)responsibleParty:(<Organization>
|<Practitioner>
|<PractitionerRole>)>?🔗 Information about a medication that is used to support knowledge.MedicationKnowledge(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< Business identifier for this medication. This is a business identifier, not a resource identifier (see discussion).; (xsd)identifier:Identifier>*
< A code that specifies this medication, or a textual description if no code is available. Usage note: This could be a standard medication code such as a code from RxNorm, SNOMED CT, IDMP etc. It could also be a national or local formulary code, optionally with translations to other code systems. Depending on the context of use, the code that was actually selected by the user (prescriber, dispenser, etc.) will have the coding.userSelected set to true. As described in the coding datatype: "A coding may be marked as a "userSelected" if a user selected the particular coded value in a user interface (e.g. the user selects an item in a pick-list). If a user selected coding exists, it is the preferred choice for performing translations etc. Other codes can only be literal translations to alternative code systems, or codes at a lower level of granularity (e.g. a generic code for a vendor-specific primary one). Binding: medication-codes (example, A coded concept that defines the type of a medication.); (xsd)code:CodeableConcept>?
< A code to indicate if the medication referred to by this MedicationKnowledge is in active use within the drug database or inventory system. The status refers to the validity about the information of the medication and not to its medicinal properties. This status is intended to identify if the medication in a local system is in active use within a drug database or inventory. For example, a pharmacy system may create a new drug file record for a compounded product "ABC Hospital Special Cream" with an active status. At some point in the future, it may be determined that the drug record was created with an error and the status is changed to "entered in error". This status is not intended to specify if a medication is part of a particular formulary. It is possible that the drug record may be referenced by multiple formularies or catalogues and each of those entries would have a separate status. Binding: medicationknowledge-status (required, A coded concept defining if the medication is in active use.); (xsd)status:code>?
< The creator or owner of the knowledge or information about the medication.; (xsd)author:Organization*>?
[]< Lists the jurisdictions that this medication knowledge was written for. The codes could have varying granularity from a country or group of countries down to a specific district.; (xsd)intendedJurisdiction:CodeableConcept>*
[]< All of the names for a medication, for example, the name(s) given to a medication in different countries. For example, acetaminophen and paracetamol or salbutamol and albuterol.; (xsd)name:string>*
[]< Associated or related medications. For example, if the medication is a branded product (e.g. Crestor), this is the Therapeutic Moeity (e.g. Rosuvastatin) or if this is a generic medication (e.g. Rosuvastatin), this would link to a branded product (e.g. Crestor.; (xsd)relatedMedicationKnowledge:MedicationKnowledge.relatedMedicationKnowledge>*
[]< Links to associated medications that could be prescribed, dispensed or administered.; (xsd)associatedMedication:Medication*>*
[]< Category of the medication or product (e.g. branded product, therapeutic moeity, generic product, innovator product, etc.).; (xsd)productType:CodeableConcept>*
[]< Associated documentation about the medication.; (xsd)monograph:MedicationKnowledge.monograph>*
< The instructions for preparing the medication.; (xsd)preparationInstruction:markdown>?
[]< The price of the medication.; (xsd)cost:MedicationKnowledge.cost>*
[]< The program under which the medication is reviewed.; (xsd)monitoringProgram:MedicationKnowledge.monitoringProgram>*
[]< Guidelines or protocols that are applicable for the administration of the medication based on indication.; (xsd)indicationGuideline:MedicationKnowledge.indicationGuideline>*
[]< Categorization of the medication within a formulary or classification system.; (xsd)medicineClassification:MedicationKnowledge.medicineClassification>*
[]< Information that only applies to packages (not products).; (xsd)packaging:MedicationKnowledge.packaging>*
[]< Potential clinical issue with or between medication(s) (for example, drug-drug interaction, drug-disease contraindication, drug-allergy interaction, etc.).; (xsd)clinicalUseIssue:ClinicalUseDefinition*>*
[]< Information on how the medication should be stored, for example, refrigeration temperatures and length of stability at a given temperature.; (xsd)storageGuideline:MedicationKnowledge.storageGuideline>*
[]< Regulatory information about a medication.; (xsd)regulatory:MedicationKnowledge.regulatory>*
< Along with the link to a Medicinal Product Definition resource, this information provides common definitional elements that are needed to understand the specific medication that is being described.; (xsd)definitional:MedicationKnowledge.definitional>?🔗 The price of the medication.MedicationKnowledge.cost(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< The date range for which the cost information of the medication is effective.; (xsd)effectiveDate:Period>*
< The category of the cost information. For example, manufacturers' cost, patient cost, claim reimbursement cost, actual acquisition cost.; (xsd)type:CodeableConcept>
< The source or owner that assigns the price to the medication.; (xsd)source:string>?
< The price or representation of the cost (for example, Band A, Band B or $, $$) of the medication. Binding: medication-cost-category (example, A coded concept defining the category of a medication.); (xsd)cost:(<CodeableConcept>
|<Money>)>🔗 Along with the link to a Medicinal Product Definition resource, this information provides common definitional elements that are needed to understand the specific medication that is being described.MedicationKnowledge.definitional(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< Associated definitions for this medication.; (xsd)definition:MedicinalProductDefinition*>*
< Describes the form of the item. Powder; tablets; capsule. When Medication is referenced from MedicationRequest, this is the ordered form. When Medication is referenced within MedicationDispense, this is the dispensed form. When Medication is referenced within MedicationAdministration, this is administered form. Binding: medication-form-codes (example, ); (xsd)doseForm:CodeableConcept>?
[]< The intended or approved route of administration. Binding: route-codes (example, ); (xsd)intendedRoute:CodeableConcept>*
[]< Identifies a particular constituent of interest in the product.; (xsd)ingredient:MedicationKnowledge.definitional.ingredient>*
[]< Specifies descriptive properties of the medicine, such as color, shape, imprints, etc.; (xsd)drugCharacteristic:MedicationKnowledge.definitional.drugCharacteristic>*🔗 Specifies descriptive properties of the medicine, such as color, shape, imprints, etc.MedicationKnowledge.definitional.drugCharacteristic(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A code specifying which characteristic of the medicine is being described (for example, colour, shape, imprint). Binding: medicationknowledge-characteristic (example, ); (xsd)type:CodeableConcept>?
(<valueAttachment:Attachment>
|<valueBase64Binary:base64Binary>
|<valueCodeableConcept:CodeableConcept>
|<valueSimpleQuantity:SimpleQuantity>
|<valueString:string>)?🔗 Identifies a particular constituent of interest in the product.MedicationKnowledge.definitional.ingredient(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A reference to the resource that provides information about the ingredient.; (xsd)item:Substance*>
< Indication of whether this ingredient affects the therapeutic action of the drug. Binding: http://terminology.hl7.org/ValueSet/v3-RoleClassIngredientEntity (example, ); (xsd)type:CodeableConcept>?
< Specifies how many (or how much) of the items there are in this Medication. For example, 250 mg per tablet. This is expressed as a ratio where the numerator is 250mg and the denominator is 1 tablet but can also be expressed a quantity when the denominator is assumed to be 1 tablet. Binding: medication-ingredientstrength (example, ); (xsd)strength:(<CodeableConcept>
|<Quantity>
|<Ratio>)>?🔗 Guidelines or protocols that are applicable for the administration of the medication based on indication.MedicationKnowledge.indicationGuideline(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< Indication or reason for use of the medication that applies to the specific administration guideline.; (xsd)indication:ClinicalUseDefinition*>*
[]< The guidelines for the dosage of the medication for the indication.; (xsd)dosingGuideline:MedicationKnowledge.indicationGuideline.dosingGuideline>*🔗 The guidelines for the dosage of the medication for the indication.MedicationKnowledge.indicationGuideline.dosingGuideline(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The overall intention of the treatment, for example, prophylactic, supporative, curative, etc.; (xsd)treatmentIntent:CodeableConcept>?
[]< Dosage for the medication for the specific guidelines.; (xsd)dosage:MedicationKnowledge.indicationGuideline.dosingGuideline.dosage>*
< The type of the treatment that the guideline applies to, for example, long term therapy, first line treatment, etc.; (xsd)administrationTreatment:CodeableConcept>?
[]< Characteristics of the patient that are relevant to the administration guidelines (for example, height, weight, gender, etc.).; (xsd)patientCharacteristic:MedicationKnowledge.indicationGuideline.dosingGuideline.patientCharacteristic>*🔗 Dosage for the medication for the specific guidelines.MedicationKnowledge.indicationGuideline.dosingGuideline.dosage(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The type or category of dosage for a given medication (for example, prophylaxis, maintenance, therapeutic, etc.).; (xsd)type:CodeableConcept>
[]< Dosage for the medication for the specific guidelines.; (xsd)dosage:Dosage>+🔗 Characteristics of the patient that are relevant to the administration guidelines (for example, height, weight, gender, etc.).MedicationKnowledge.indicationGuideline.dosingGuideline.patientCharacteristic(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The categorization of the specific characteristic that is relevant to the administration guideline (e.g. height, weight, gender).; (xsd)type:CodeableConcept>
(<valueCodeableConcept:CodeableConcept>
|<valueQuantity:Quantity>
|<valueRange:Range>)?🔗 Categorization of the medication within a formulary or classification system.MedicationKnowledge.medicineClassification(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The type of category for the medication (for example, therapeutic classification, therapeutic sub-classification).; (xsd)type:CodeableConcept>
< Either a textual source of the classification or a reference to an online source.; (xsd)source:(<string>
|<uri>)>?
[]< Specific category assigned to the medication (e.g. anti-infective, anti-hypertensive, antibiotic, etc.).; (xsd)classification:CodeableConcept>*🔗 The program under which the medication is reviewed.MedicationKnowledge.monitoringProgram(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Type of program under which the medication is monitored.; (xsd)type:CodeableConcept>?
< Name of the reviewing program.; (xsd)name:string>?🔗 Associated documentation about the medication.MedicationKnowledge.monograph(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The category of documentation about the medication. (e.g. professional monograph, patient education monograph).; (xsd)type:CodeableConcept>?
< Associated documentation about the medication.; (xsd)source:DocumentReference*>?🔗 Information that only applies to packages (not products).MedicationKnowledge.packaging(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< The cost of the packaged medication.; (xsd)cost:MedicationKnowledge.cost>*
< A reference to a PackagedProductDefinition that provides the details of the product that is in the packaging and is being priced.; (xsd)packagedProduct:PackagedProductDefinition*>?🔗 Regulatory information about a medication.MedicationKnowledge.regulatory(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The authority that is specifying the regulations.; (xsd)regulatoryAuthority:Organization*>
[]< Specifies if changes are allowed when dispensing a medication from a regulatory perspective.; (xsd)substitution:MedicationKnowledge.regulatory.substitution>*
[]< Specifies the schedule of a medication in jurisdiction.; (xsd)schedule:CodeableConcept>*
< The maximum number of units of the medication that can be dispensed in a period.; (xsd)maxDispense:MedicationKnowledge.regulatory.maxDispense>?🔗 The maximum number of units of the medication that can be dispensed in a period.MedicationKnowledge.regulatory.maxDispense(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The maximum number of units of the medication that can be dispensed.; (xsd)quantity:SimpleQuantity>
< The period that applies to the maximum number of units.; (xsd)period:Duration>?🔗 Specifies if changes are allowed when dispensing a medication from a regulatory perspective.MedicationKnowledge.regulatory.substitution(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Specifies the type of substitution allowed.; (xsd)type:CodeableConcept>
< Specifies if regulation allows for changes in the medication when dispensing.; (xsd)allowed:boolean>🔗 Associated or related medications. For example, if the medication is a branded product (e.g. Crestor), this is the Therapeutic Moeity (e.g. Rosuvastatin) or if this is a generic medication (e.g. Rosuvastatin), this would link to a branded product (e.g. Crestor.MedicationKnowledge.relatedMedicationKnowledge(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The category of the associated medication knowledge reference.; (xsd)type:CodeableConcept>
[]< Associated documentation about the associated medication knowledge.; (xsd)reference:MedicationKnowledge*>+🔗 Information on how the medication should be stored, for example, refrigeration temperatures and length of stability at a given temperature.MedicationKnowledge.storageGuideline(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Reference to additional information about the storage guidelines.; (xsd)reference:uri>?
[]< Additional notes about the storage.; (xsd)note:Annotation>*
< Duration that the medication remains stable if the environmentalSetting is respected.; (xsd)stabilityDuration:Duration>?
[]< Describes a setting/value on the environment for the adequate storage of the medication and other substances. Environment settings may involve temperature, humidity, or exposure to light.; (xsd)environmentalSetting:MedicationKnowledge.storageGuideline.environmentalSetting>*🔗 Describes a setting/value on the environment for the adequate storage of the medication and other substances. Environment settings may involve temperature, humidity, or exposure to light.MedicationKnowledge.storageGuideline.environmentalSetting(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Identifies the category or type of setting (e.g., type of location, temperature, humidity).; (xsd)type:CodeableConcept>
(<valueCodeableConcept:CodeableConcept>
|<valueQuantity:Quantity>
|<valueRange:Range>)🔗 An order or request for both supply of the medication and the instructions for administration of the medication to a patient. The resource is called "MedicationRequest" rather than "MedicationPrescription" or "MedicationOrder" to generalize the use across inpatient and outpatient settings, including care plans, etc., and to harmonize with workflow patterns.MedicationRequest(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< Identifiers associated with this medication request that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server. This is a business identifier, not a resource identifier.; (xsd)identifier:Identifier>*
[]< A plan or request that is fulfilled in whole or in part by this medication request.; (xsd)basedOn:(<CarePlan>
|<ImmunizationRecommendation>
|<MedicationRequest>
|<ServiceRequest>)>*
< Reference to an order/prescription that is being replaced by this MedicationRequest.; (xsd)priorPrescription:MedicationRequest*>?
< A shared identifier common to multiple independent Request instances that were activated/authorized more or less simultaneously by a single author. The presence of the same identifier on each request ties those requests together and may have business ramifications in terms of reporting of results, billing, etc. E.g. a requisition number shared by a set of lab tests ordered together, or a prescription number shared by all meds ordered at one time.; (xsd)groupIdentifier:Identifier>?
< A code specifying the current state of the order. Generally, this will be active or completed state. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.
Clinical decision support systems should take the status into account when determining which medications to include in their algorithms. Binding: medicationrequest-status (required, A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription.); (xsd)status:code>
< Captures the reason for the current state of the MedicationRequest. This is generally only used for "exception" statuses such as "suspended" or "cancelled". The reason why the MedicationRequest was created at all is captured in reasonCode, not here. Binding: medicationrequest-status-reason (example, Identifies the reasons for a given status.); (xsd)statusReason:CodeableConcept>?
< The date (and perhaps time) when the status was changed.; (xsd)statusChanged:dateTime>?
< Whether the request is a proposal, plan, or an original order. It is expected that the type of requester will be restricted for different stages of a MedicationRequest. For example, Proposals can be created by a patient, relatedPerson, Practitioner or Device. Plans can be created by Practitioners, Patients, RelatedPersons and Devices. Original orders can be created by a Practitioner only.
An instance-order is an instantiation of a request or order and may be used to populate Medication Administration Record.
This element is labeled as a modifier because the intent alters when and how the resource is actually applicable. Binding: medicationrequest-intent (required, The kind of medication order.); (xsd)intent:code>
[]< An arbitrary categorization or grouping of the medication request. It could be used for indicating where meds are intended to be administered, eg. in an inpatient setting or in a patient's home, or a legal category of the medication. The category can be used to include where the medication is expected to be consumed or other types of requests. The examplar value set represents where the meds are intended to be administered and is just one example of request categorization. Binding: medicationrequest-admin-location (example, A coded concept identifying where the medication is to be consumed or administered.); (xsd)category:CodeableConcept>*
< Indicates how quickly the Medication Request should be addressed with respect to other requests. Binding: request-priority (required, Identifies the level of importance to be assigned to actioning the request.); (xsd)priority:code>?
< If true, indicates that the provider is asking for the patient to either stop taking or to not start taking the specified medication. For example, the patient is taking an existing medication and the provider is changing their medication. They want to create two seperate requests: one to stop using the current medication and another to start the new medication. If do not perform is not specified, the request is a positive request e.g. "do perform".; (xsd)doNotPerform:boolean>?
< Identifies the medication being requested. This is a link to a resource that represents the medication which may be the details of the medication or simply an attribute carrying a code that identifies the medication from a known list of medications. If only a code is specified, then it needs to be a code for a specific product. If more information is required, then the use of the Medication resource is recommended. For example, if you require form or lot number or if the medication is compounded or extemporaneously prepared, then you must reference the Medication resource. Binding: medication-codes (example, A coded concept identifying substance or product that can be ordered.); (xsd)medication:Medication*>
< The individual or group for whom the medication has been requested. The subject on a medication request is mandatory. For the secondary use case where the actual subject is not provided, there still must be an anonymized subject specified.; (xsd)subject:(<Group>
|<Patient>)>
[]< The person or organization who provided the information about this request, if the source is someone other than the requestor. This is often used when the MedicationRequest is reported by another person.; (xsd)informationSource:(<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>*
< The Encounter during which this [x] was created or to which the creation of this record is tightly associated. This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter." If there is a need to link to episodes of care they will be handled with an extension.; (xsd)encounter:Encounter*>?
[]< Information to support fulfilling (i.e. dispensing or administering) of the medication, for example, patient height and weight, a MedicationStatement for the patient). This attribute can be used to reference a MedicationStatement about the patients' medication use.; (xsd)supportingInformation:Resource*>*
< The date (and perhaps time) when the prescription was initially written or authored on.; (xsd)authoredOn:dateTime>?
< The individual, organization, or device that initiated the request and has responsibility for its activation.; (xsd)requester:(<Device>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>?
< Indicates if this record was captured as a secondary 'reported' record rather than as an original primary source-of-truth record. It may also indicate the source of the report. If not populated, then assume that this is the original record and not reported; (xsd)reported:boolean>?
< Indicates the type of performer of the administration of the medication. If specified without indicating a performer, this indicates that the performer must be of the specified type. If specified with a performer then it indicates the requirements of the performer if the designated performer is not available. Binding: medication-intended-performer-role (extensible, Identifies the type of individual that is desired to administer the medication.); (xsd)performerType:CodeableConcept>?
[]< The specified desired performer of the medication treatment (e.g. the performer of the medication administration). For devices, this is the device that is intended to perform the administration of the medication. An IV Pump would be an example of a device that is performing the administration. Both the IV Pump and the practitioner that set the rate or bolus on the pump can be listed as performers.; (xsd)performer:(<CareTeam>
|<DeviceDefinition>
|<HealthcareService>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>*
[]< The intended type of device that is to be used for the administration of the medication (for example, PCA Pump).; (xsd)device:DeviceDefinition*>*
< The person who entered the order on behalf of another individual for example in the case of a verbal or a telephone order.; (xsd)recorder:(<Practitioner>
|<PractitionerRole>)>?
[]< The reason or the indication for ordering or not ordering the medication. This could be a diagnosis code. If a full condition record exists or additional detail is needed, use reasonReference. Binding: condition-code (example, A coded concept indicating why the medication was ordered.); (xsd)reason:(<Condition>
|<Observation>)>*
< The description of the overall pattern of the administration of the medication to the patient. This attribute should not be confused with the protocol of the medication. Binding: medicationrequest-course-of-therapy (extensible, Identifies the overall pattern of medication administratio.); (xsd)courseOfTherapyType:CodeableConcept>?
[]< Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be required for delivering the requested service.; (xsd)insurance:(<ClaimResponse>
|<Coverage>)>*
[]< Extra information about the prescription that could not be conveyed by the other attributes.; (xsd)note:Annotation>*
< The full representation of the dose of the medication included in all dosage instructions. To be used when multiple dosage instructions are included to represent complex dosing such as increasing or tapering doses.; (xsd)renderedDosageInstruction:markdown>?
< The period over which the medication is to be taken. Where there are multiple dosageInstruction lines (for example, tapering doses), this is the earliest date and the latest end date of the dosageInstructions.; (xsd)effectiveDosePeriod:Period>?
[]< Specific instructions for how the medication is to be used by the patient. There are examples where a medication request may include the option of an oral dose or an Intravenous or Intramuscular dose. For example, "Ondansetron 8mg orally or IV twice a day as needed for nausea" or "Compazine® (prochlorperazine) 5-10mg PO or 25mg PR bid prn nausea or vomiting". In these cases, two medication requests would be created that could be grouped together. The decision on which dose and route of administration to use is based on the patient's condition at the time the dose is needed. In general, each prescribed drug will be a separate Medication Request.
When drug orders are grouped together at the time of order entry, but each of the drugs can be manipulated independently e.g. changing the status of one order to "completed" or "cancelled", changing another order status to "on-hold", the method to "group" all of the medication requests together is to use MedicationRequest.groupIdentifier element. All of the orders grouped together in this manner will have the same groupIdentifier, and separately, each order in the group may have a unique identifier.
There are cases that require grouping of Medication orders together when it is necessary to specify optionality e.g. order two drugs at one time, but stating either of these drugs may be used to treat the patient. The use of a RequestOrchestration should be used as a parent for the Medication orders that require this type of grouping. An example when it may be necessary to group medication orders together is when you specify timing relationships e.g. order drug "xyz" with dose 123, then taper the same drug to a different dose after some interval of time
precedence:
e.g. give drug "abc" followed by drug "def"
e.g. give drug 30 minutes before some procedure was performed
more generically this supports - hierarchical groups of actions, where each specific action references the action to be performed (in terms of a Request resource), and each group describes additional behavior, relationships, and applicable conditions between the actions in the overall group.
Note that one should NOT use the List or Composition resource to accomplish the above requirements. You may use List or Composition for other business requirements, but not to address the specific requirements of grouping medication orders.; (xsd)dosageInstruction:Dosage>*
< Indicates the specific details for the dispense or medication supply part of a medication request (also known as a Medication Prescription or Medication Order). Note that this information is not always sent with the order. There may be in some settings (e.g. hospitals) institutional or system support for completing the dispense details in the pharmacy department.; (xsd)dispenseRequest:MedicationRequest.dispenseRequest>?
< Indicates whether or not substitution can or should be part of the dispense. In some cases, substitution must happen, in other cases substitution must not happen. This block explains the prescriber's intent. If nothing is specified substitution may be done.; (xsd)substitution:MedicationRequest.substitution>?
[]< Links to Provenance records for past versions of this resource or fulfilling request or event resources that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the resource. This might not include provenances for all versions of the request – only those deemed "relevant" or important. This SHALL NOT include the provenance associated with this current version of the resource. (If that provenance is deemed to be a "relevant" change, it will need to be added as part of a later update. Until then, it can be queried directly as the provenance that points to this version using _revinclude All Provenances should have some historical version of this Request as their subject.).; (xsd)eventHistory:Provenance*>*🔗 Indicates the specific details for the dispense or medication supply part of a medication request (also known as a Medication Prescription or Medication Order). Note that this information is not always sent with the order. There may be in some settings (e.g. hospitals) institutional or system support for completing the dispense details in the pharmacy department.MedicationRequest.dispenseRequest(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Indicates the quantity or duration for the first dispense of the medication. If populating this element, either the quantity or the duration must be included.; (xsd)initialFill:MedicationRequest.dispenseRequest.initialFill>?
< The minimum period of time that must occur between dispenses of the medication.; (xsd)dispenseInterval:Duration>?
< This indicates the validity period of a prescription (stale dating the Prescription). It reflects the prescribers' perspective for the validity of the prescription. Dispenses must not be made against the prescription outside of this period. The lower-bound of the Dispensing Window signifies the earliest date that the prescription can be filled for the first time. If an upper-bound is not specified then the Prescription is open-ended or will default to a stale-date based on regulations.; (xsd)validityPeriod:Period>?
< An integer indicating the number of times, in addition to the original dispense, (aka refills or repeats) that the patient can receive the prescribed medication. Usage Notes: This integer does not include the original order dispense. This means that if an order indicates dispense 30 tablets plus "3 repeats", then the order can be dispensed a total of 4 times and the patient can receive a total of 120 tablets. A prescriber may explicitly say that zero refills are permitted after the initial dispense. If displaying "number of authorized fills", add 1 to this number.; (xsd)numberOfRepeatsAllowed:unsignedInt>?
< The amount that is to be dispensed for one fill.; (xsd)quantity:SimpleQuantity>?
< Identifies the period time over which the supplied product is expected to be used, or the length of time the dispense is expected to last. In some situations, this attribute may be used instead of quantity to identify the amount supplied by how long it is expected to last, rather than the physical quantity issued, e.g. 90 days supply of medication (based on an ordered dosage). When possible, it is always better to specify quantity, as this tends to be more precise. expectedSupplyDuration will always be an estimate that can be influenced by external factors.; (xsd)expectedSupplyDuration:Duration>?
< Indicates the intended performing Organization that will dispense the medication as specified by the prescriber.; (xsd)dispenser:Organization*>?
[]< Provides additional information to the dispenser, for example, counselling to be provided to the patient.; (xsd)dispenserInstruction:Annotation>*
< Provides information about the type of adherence packaging to be supplied for the medication dispense. Binding: medication-dose-aid (example, ); (xsd)doseAdministrationAid:CodeableConcept>?🔗 Indicates the quantity or duration for the first dispense of the medication. If populating this element, either the quantity or the duration must be included.MedicationRequest.dispenseRequest.initialFill(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The amount or quantity to provide as part of the first dispense.; (xsd)quantity:SimpleQuantity>?
< The length of time that the first dispense is expected to last.; (xsd)duration:Duration>?🔗 Indicates whether or not substitution can or should be part of the dispense. In some cases, substitution must happen, in other cases substitution must not happen. This block explains the prescriber's intent. If nothing is specified substitution may be done.MedicationRequest.substitution(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< True if the prescriber allows a different drug to be dispensed from what was prescribed. This element is labeled as a modifier because whether substitution is allow or not, it cannot be ignored. Binding: http://terminology.hl7.org/ValueSet/v3-ActSubstanceAdminSubstitutionCode (preferred, Identifies the type of substitution allowed.); (xsd)allowed:(<boolean>
|<CodeableConcept>)>
< Indicates the reason for the substitution, or why substitution must or must not be performed. Binding: http://terminology.hl7.org/ValueSet/v3-SubstanceAdminSubstitutionReason (example, SubstanceAdminSubstitutionReason); (xsd)reason:CodeableConcept>?🔗 A record of a medication that is being consumed by a patient. A MedicationStatement may indicate that the patient may be taking the medication now or has taken the medication in the past or will be taking the medication in the future. The source of this information can be the patient, significant other (such as a family member or spouse), or a clinician. A common scenario where this information is captured is during the history taking process during a patient visit or stay. The medication information may come from sources such as the patient's memory, from a prescription bottle, or from a list of medications the patient, clinician or other party maintains.
The primary difference between a medicationstatement and a medicationadministration is that the medication administration has complete administration information and is based on actual administration information from the person who administered the medication. A medicationstatement is often, if not always, less specific. There is no required date/time when the medication was administered, in fact we only know that a source has reported the patient is taking this medication, where details such as time, quantity, or rate or even medication product may be incomplete or missing or less precise. As stated earlier, the Medication Statement information may come from the patient's memory, from a prescription bottle or from a list of medications the patient, clinician or other party maintains. Medication administration is more formal and is not missing detailed information.
The MedicationStatement resource was previously called MedicationStatement.MedicationStatement(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< Identifiers associated with this Medication Statement that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server. This is a business identifier, not a resource identifier.; (xsd)identifier:Identifier>*
[]< A larger event of which this particular MedicationStatement is a component or step.; (xsd)partOf:(<MedicationStatement>
|<Procedure>)>*
< A code representing the status of recording the medication statement. This status concerns just the recording of the medication statement. MedicationStatement.adherence should be used for indicating a patient's adherence to the information in this resource. Note, the statuses are different than in previous releases for MedicationStatement or MedicationStatement.
This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. Binding: medication-statement-status (required, A coded concept indicating the current status of a MedicationStatement.); (xsd)status:code>
[]< Type of medication statement (for example, drug classification like ATC, where meds would be administered, legal category of the medication.). Binding: medicationrequest-admin-location (example, A coded concept identifying where the medication included in the MedicationStatement is expected to be consumed or administered.); (xsd)category:CodeableConcept>*
< Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications. If only a code is specified, then it needs to be a code for a specific product. If more information is required, then the use of the medication resource is recommended. For example, if you require form or lot number, then you must reference the Medication resource. Binding: medication-codes (example, A coded concept identifying the substance or product being taken.); (xsd)medication:Medication*>
< The person, animal or group who is/was taking the medication.; (xsd)subject:(<Group>
|<Patient>)>
< The encounter that establishes the context for this MedicationStatement.; (xsd)encounter:Encounter*>?
< The interval of time during which it is being asserted that the patient is/was/will be taking the medication (or was not taking, when the MedicationStatement.adherence element is Not Taking). This attribute reflects the period over which the patient consumed the medication and is expected to be populated on the majority of Medication Statements. If the medication is still being taken and is expected to continue indefinitely at the time the usage is recorded, the "end" date will be omitted. If the end date is known, then it is included as the "end date". The date/time attribute supports a variety of dates - year, year/month and exact date. If something more than this is required, this should be conveyed as text.; (xsd)effective:(<dateTime>
|<Period>
|<Timing>)>?
< The date when the Medication Statement was asserted by the information source.; (xsd)dateAsserted:dateTime>?
[]< The person or organization that provided the information about the taking of this medication. Note: Use derivedFrom when a MedicationStatement is derived from other resources, e.g. Claim or MedicationRequest.; (xsd)informationSource:(<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>*
[]< Allows linking the MedicationStatement to the underlying MedicationRequest, or to other information that supports or is used to derive the MedicationStatement. Likely references would be to MedicationRequest, MedicationDispense, Claim, Observation or QuestionnaireAnswers. The most common use cases for deriving a MedicationStatement comes from creating a MedicationStatement from a MedicationRequest or from a lab observation or a claim. it should be noted that the amount of information that is available varies from the type resource that you derive the MedicationStatement from.; (xsd)derivedFrom:Resource*>*
[]< A concept, Condition or observation that supports why the medication is being/was taken. This could be a diagnosis code. If a full condition record exists or additional detail is needed, use reasonForUseReference. Binding: condition-code (example, A coded concept identifying why the medication is being taken.); (xsd)reason:(<Condition>
|<DiagnosticReport>
|<Observation>)>*
[]< Provides extra information about the Medication Statement that is not conveyed by the other attributes.; (xsd)note:Annotation>*
[]< Link to information that is relevant to a medication statement, for example, illicit drug use, gestational age, etc.; (xsd)relatedClinicalInformation:(<Condition>
|<Observation>)>*
< The full representation of the dose of the medication included in all dosage instructions. To be used when multiple dosage instructions are included to represent complex dosing such as increasing or tapering doses.; (xsd)renderedDosageInstruction:markdown>?
[]< Indicates how the medication is/was or should be taken by the patient. The dates included in the dosage on a Medication Statement reflect the dates for a given dose. For example, "from November 1, 2016 to November 3, 2016, take one tablet daily and from November 4, 2016 to November 7, 2016, take two tablets daily." It is expected that this specificity may only be populated where the patient brings in their labeled container or where the Medication Statement is derived from a MedicationRequest.; (xsd)dosage:Dosage>*
< Indicates whether the medication is or is not being consumed or administered. This element can be used to indicate whether a patient is following a course of treatment as instructed/prescribed or whether they are taking medications of their own volition. It can also be used to indicate that a patient is not taking a medication, either because they were told not to or because they decided on their own.; (xsd)adherence:MedicationStatement.adherence>?🔗 Indicates whether the medication is or is not being consumed or administered. This element can be used to indicate whether a patient is following a course of treatment as instructed/prescribed or whether they are taking medications of their own volition. It can also be used to indicate that a patient is not taking a medication, either because they were told not to or because they decided on their own.MedicationStatement.adherence(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Type of the adherence for the medication. Binding: medication-statement-adherence (example, ); (xsd)code:CodeableConcept>
< Captures the reason for the current use or adherence of a medication. This is generally only used for "exception" statuses such as "entered-in-error". The reason for performing the event at all is captured in reasonCode, not here. Binding: reason-medication-status-codes (example, ); (xsd)reason:CodeableConcept>?🔗 A medicinal product, being a substance or combination of substances that is intended to treat, prevent or diagnose a disease, or to restore, correct or modify physiological functions by exerting a pharmacological, immunological or metabolic action. This resource is intended to define and detail such products and their properties, for uses other than direct patient care (e.g. regulatory use, or drug catalogs).MedicinalProductDefinition(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< Business identifier for this product. Could be an MPID. When in development or being regulated, products are typically referenced by official identifiers, assigned by a manufacturer or regulator, and unique to a product (which, when compared to a product instance being prescribed, is actually a product type). See also MedicinalProductDefinition.code.; (xsd)identifier:Identifier>*
< Regulatory type, e.g. Investigational or Authorized. Binding: medicinal-product-type (example, Overall defining type of this medicinal product.); (xsd)type:CodeableConcept>?
< If this medicine applies to human or veterinary uses. Binding: medicinal-product-domain (example, Applicable domain for this product (e.g. human, veterinary).); (xsd)domain:CodeableConcept>?
< A business identifier relating to a specific version of the product, this is commonly used to support revisions to an existing product.; (xsd)version:string>?
< The status within the lifecycle of this product record. A high-level status, this is not intended to duplicate details carried elsewhere such as legal status, or authorization status. Binding: publication-status (preferred, The lifecycle status of an artifact.); (xsd)status:CodeableConcept>?
< The date at which the given status became applicable.; (xsd)statusDate:dateTime>?
< General description of this product.; (xsd)description:markdown>?
< The dose form for a single part product, or combined form of a multiple part product. This is one concept that describes all the components. It does not represent the form with components physically mixed, if that might be necessary, for which see (AdministrableProductDefinition.administrableDoseForm). Binding: combined-dose-form (example, Dose forms for a product as a whole, considering all individual parts, but before any mixing); (xsd)combinedPharmaceuticalDoseForm:CodeableConcept>?
[]< The path by which the product is taken into or makes contact with the body. In some regions this is referred to as the licenced or approved route. See also AdministrableProductDefinition resource. MedicinalProductDefinition.route is the same concept as AdministrableProductDefinition.routeOfAdministration.code, and they cannot be used together. Binding: route-codes (example, A code specifying the route or physiological path of administration of a therapeutic agent into or onto a patient's body.); (xsd)route:CodeableConcept>*
< Description of indication(s) for this product, used when structured indications are not required. In cases where structured indications are required, they are captured using the ClinicalUseDefinition resource. An indication is a medical situation for which using the product is appropriate.; (xsd)indication:markdown>?
< The legal status of supply of the medicinal product as classified by the regulator. Binding: legal-status-of-supply (example, The prescription supply types appropriate to a medicinal product); (xsd)legalStatusOfSupply:CodeableConcept>?
< Whether the Medicinal Product is subject to additional monitoring for regulatory reasons, such as heightened reporting requirements. Binding: medicinal-product-additional-monitoring (example, Extra measures defined for a Medicinal Product, such as heightened reporting requirements (e.g. Black Triangle Monitoring).); (xsd)additionalMonitoringIndicator:CodeableConcept>?
[]< Whether the Medicinal Product is subject to special measures for regulatory reasons, such as a requirement to conduct post-authorization studies. Binding: medicinal-product-special-measures (example, Extra measures defined for a Medicinal Product, such as a requirement to conduct post-authorization studies.); (xsd)specialMeasures:CodeableConcept>*
< If authorised for use in children, or infants, neonates etc. Binding: medicinal-product-pediatric-use (example, Suitability for age groups, in particular children.); (xsd)pediatricUseIndicator:CodeableConcept>?
[]< Allows the product to be classified by various systems, commonly WHO ATC. Binding: medicinal-product-classification (example, This value set includes codes from the Anatomical Therapeutic Chemical Classification System - provided as an exemplar value set.); (xsd)classification:CodeableConcept>*
[]< Marketing status of the medicinal product, in contrast to marketing authorization. This refers to the product being actually 'on the market' as opposed to being allowed to be on the market (which is an authorization).; (xsd)marketingStatus:MarketingStatus>*
[]< Package type for the product. See also the PackagedProductDefinition resource. Binding: medicinal-product-package-type (example, Types of medicinal product packs); (xsd)packagedMedicinalProduct:CodeableConcept>*
[]< Types of medicinal manufactured items and/or devices that this product consists of, such as tablets, capsule, or syringes. Used as a direct link when the item's packaging is not being recorded (see also PackagedProductDefinition.package.containedItem.item).; (xsd)comprisedOf:(<DeviceDefinition>
|<ManufacturedItemDefinition>)>*
[]< The ingredients of this medicinal product - when not detailed in other resources. This is only needed if the ingredients are not specified by incoming references from the Ingredient resource, or indirectly via incoming AdministrableProductDefinition, PackagedProductDefinition or ManufacturedItemDefinition references. In cases where those levels of detail are not used, the ingredients may be specified directly here as codes. Binding: substance-codes (example, This value set includes all substance codes from SNOMED CT - provided as an exemplar value set.); (xsd)ingredient:CodeableConcept>*
[]< Any component of the drug product which is not the chemical entity defined as the drug substance, or an excipient in the drug product. This includes process-related impurities and contaminants, product-related impurities including degradation products. Binding: substance-codes (example, This value set includes all substance codes from SNOMED CT - provided as an exemplar value set.); (xsd)impurity:SubstanceDefinition*>*
[]< Additional information or supporting documentation about the medicinal product.; (xsd)attachedDocument:DocumentReference*>*
[]< A master file for the medicinal product (e.g. Pharmacovigilance System Master File). Drug master files (DMFs) are documents submitted to regulatory agencies to provide confidential detailed information about facilities, processes or articles used in the manufacturing, processing, packaging and storing of drug products.; (xsd)masterFile:DocumentReference*>*
[]< A product specific contact, person (in a role), or an organization.; (xsd)contact:MedicinalProductDefinition.contact>*
[]< Clinical trials or studies that this product is involved in.; (xsd)clinicalTrial:ResearchStudy*>*
[]< A code that this product is known by, usually within some formal terminology, perhaps assigned by a third party (i.e. not the manufacturer or regulator). Products (types of medications) tend to be known by identifiers during development and within regulatory process. However when they are prescribed they tend to be identified by codes. The same product may be have multiple codes, applied to it by multiple organizations. Binding: medication-codes (example, A coded concept that defines the type of a medication.); (xsd)code:Coding>*
[]< The product's name, including full name and possibly coded parts.; (xsd)name:MedicinalProductDefinition.name>+
[]< Reference to another product, e.g. for linking authorised to investigational product, or a virtual product.; (xsd)crossReference:MedicinalProductDefinition.crossReference>*
[]< A manufacturing or administrative process or step associated with (or performed on) the medicinal product.; (xsd)operation:MedicinalProductDefinition.operation>*
[]< Allows the key product features to be recorded, such as "sugar free", "modified release", "parallel import".; (xsd)characteristic:MedicinalProductDefinition.characteristic>*🔗 A product specific contact, person (in a role), or an organization.MedicinalProductDefinition.contact(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Allows the contact to be classified, for example QPPV, Pharmacovigilance Enquiry Information. Binding: medicinal-product-contact-type (example, Extra measures defined for a Medicinal Product, such as heightened reporting requirements.); (xsd)type:CodeableConcept>?
< A product specific contact, person (in a role), or an organization.; (xsd)contact:(<Organization>
|<PractitionerRole>)>🔗 Reference to another product, e.g. for linking authorised to investigational product, or a virtual product.MedicinalProductDefinition.crossReference(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Reference to another product, e.g. for linking authorised to investigational product.; (xsd)product:MedicinalProductDefinition*>
< The type of relationship, for instance branded to generic, virtual to actual product, product to development product (investigational), parallel import version. Binding: medicinal-product-cross-reference-type (example, Extra measures defined for a Medicinal Product, such as heightened reporting requirements.); (xsd)type:CodeableConcept>?🔗 Allows the key product features to be recorded, such as "sugar free", "modified release", "parallel import".MedicinalProductDefinition.characteristic(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A code expressing the type of characteristic. Binding: product-characteristic-codes (example, This value set includes all observable entity codes from SNOMED CT - provided as an exemplar value set.); (xsd)type:CodeableConcept>
(<valueAttachment:Attachment>
|<valueBoolean:boolean>
|<valueCodeableConcept:CodeableConcept>
|<valueDate:date>
|<valueInteger:integer>
|<valueMarkdown:markdown>
|<valueQuantity:Quantity>)?🔗 The product's name, including full name and possibly coded parts.MedicinalProductDefinition.name(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The full product name.; (xsd)productName:string>
< Type of product name, such as rINN, BAN, Proprietary, Non-Proprietary. Binding: medicinal-product-name-type (example, Type of a name for a Medicinal Product.); (xsd)type:CodeableConcept>?
[]< Coding words or phrases of the name.; (xsd)part:MedicinalProductDefinition.name.part>*
[]< Country and jurisdiction where the name applies, and associated language.; (xsd)usage:MedicinalProductDefinition.name.usage>*🔗 Coding words or phrases of the name.MedicinalProductDefinition.name.part(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A fragment of a product name.; (xsd)part:string>
< Identifying type for this part of the name (e.g. strength part). Binding: medicinal-product-name-part-type (example, Type of part of a name for a Medicinal Product.); (xsd)type:CodeableConcept>🔗 Country and jurisdiction where the name applies, and associated language.MedicinalProductDefinition.name.usage(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Country code for where this name applies. Binding: country (example, Jurisdiction codes); (xsd)country:CodeableConcept>
< Jurisdiction code for where this name applies. A jurisdiction may be a sub- or supra-national entity (e.g. a state or a geographic region). Binding: jurisdiction (example, Jurisdiction codes); (xsd)jurisdiction:CodeableConcept>?
< Language code for this name. Binding: all-languages (required, IETF language tag for a human language); (xsd)language:CodeableConcept>🔗 A manufacturing or administrative process or step associated with (or performed on) the medicinal product.MedicinalProductDefinition.operation(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The type of manufacturing operation e.g. manufacturing itself, re-packaging. For the authorization of this, a RegulatedAuthorization would point to the same plan or activity referenced here.; (xsd)type:(<ActivityDefinition>
|<PlanDefinition>)>?
< Date range of applicability.; (xsd)effectiveDate:Period>?
[]< The organization or establishment responsible for (or associated with) the particular process or step, examples include the manufacturer, importer, agent.; (xsd)organization:Organization*>*
< Specifies whether this particular business or manufacturing process is considered proprietary or confidential. Binding: medicinal-product-confidentiality (example, Confidentiality rating, e.g. commercial sensitivity for a Medicinal Product.); (xsd)confidentialityIndicator:CodeableConcept>?🔗 Defines the characteristics of a message that can be shared between systems, including the type of event that initiates the message, the content to be transmitted and what response(s), if any, are permitted. This would be a MIF-level artifact.MessageDefinition(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< The business identifier that is used to reference the MessageDefinition and *is* expected to be consistent from server to server. Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.
The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions).
In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.; (xsd)url:uri>?
[]< A formal identifier that is used to identify this message definition when it is represented in other formats, or referenced in a specification, model, design or an instance. Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this message definition outside of FHIR, where it is not possible to use the logical URI.; (xsd)identifier:Identifier>*
< The identifier that is used to identify this version of the message definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the message definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. There may be different message definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the message definition with the format [url]|[version]. The version SHOULD NOT contain a '#' - see [Business Version](resource.html#bv-format).; (xsd)version:string>?
< Indicates the mechanism used to compare versions to determine which is more current. If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined. Binding: version-algorithm (extensible, ); (xsd)versionAlgorithm:(<Coding>
|<string>)>?
< A natural language name identifying the message definition. This name should be usable as an identifier for the module by machine processing applications such as code generation. The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.; (xsd)name:string>?
< A short, descriptive, user-friendly title for the message definition. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.; (xsd)title:string>?
[]< A MessageDefinition that is superseded by this definition.; (xsd)replaces:MessageDefinition*>*
< The status of this message definition. Enables tracking the life-cycle of the content. Allows filtering of message definitions that are appropriate for use versus not.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization). Binding: publication-status (required, The lifecycle status of an artifact.); (xsd)status:code>
< A Boolean value to indicate that this message definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. Allows filtering of message definitions that are appropriate for use versus not.; (xsd)experimental:boolean>?
< The date (and optionally time) when the message definition was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the message definition changes. The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the message definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)date:dateTime>
< The name of the organization or individual responsible for the release and ongoing maintenance of the message definition. Usually an organization but may be an individual. The publisher (or steward) of the message definition is the organization or individual primarily responsible for the maintenance and upkeep of the message definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the message definition. This item SHOULD be populated unless the information is available from context.; (xsd)publisher:string>?
[]< Contact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)contact:ContactDetail>*
< A free text natural language description of the message definition from a consumer's perspective. This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the message definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the message definition is presumed to be the predominant language in the place the message definition was created).; (xsd)description:markdown>?
[]< The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate message definition instances. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.; (xsd)useContext:UsageContext>*
[]< A legal or geographic region in which the message definition is intended to be used. It may be possible for the message definition to be used in jurisdictions other than those for which it was originally designed or intended.
DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.) Binding: jurisdiction (extensible, Countries and regions within which this artifact is targeted for use.); (xsd)jurisdiction:CodeableConcept>*
< Explanation of why this message definition is needed and why it has been designed as it has. This element does not describe the usage of the message definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this message definition.; (xsd)purpose:markdown>?
< A copyright statement relating to the message definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the message definition.; (xsd)copyright:markdown>?
< A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved'). The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.; (xsd)copyrightLabel:string>?
< The MessageDefinition that is the basis for the contents of this resource.; (xsd)base:MessageDefinition*>?
[]< Identifies a protocol or workflow that this MessageDefinition represents a step in. It should be possible to use MessageDefinition to describe a message to be used by certain steps in a particular protocol as part of a PlanDefinition or ActivityDefinition.; (xsd)parent:(<ActivityDefinition>
|<PlanDefinition>)>*
< Event code or link to the EventDefinition. Binding: message-events (example, One of the message events defined as part of this version of FHIR.); (xsd)event:(<Coding>
|<uri>)>
< The impact of the content of the message. Binding: message-significance-category (required, The impact of the content of a message.); (xsd)category:code>?
[]< Identifies the resource (or resources) that are being addressed by the event. For example, the Encounter for an admit message or two Account records for a merge.; (xsd)focus:MessageDefinition.focus>*
< Declare at a message definition level whether a response is required or only upon error or success, or never. This enables the capability currently available through MSH-16 (Application Level acknowledgement) in HL7 Version 2 to declare at a message instance level whether a response is required or only upon error or success, or never. Binding: messageheader-response-request (required, This enables the capability currently available through MSH-16 (Application Level acknowledgement) in HL7 Version 2 to declare at a message definition level whether a response is required or only upon error or success, or never.); (xsd)responseRequired:code>?
[]< Indicates what types of messages may be sent as an application-level response to this message. This indicates an application level response to "close" a transaction implicit in a particular request message. To define a complete workflow scenario, look to the [[PlanDefinition]] resource which allows the definition of complex orchestrations, conditionality, etc.; (xsd)allowedResponse:MessageDefinition.allowedResponse>*
< Graph is Canonical reference to a GraphDefinition. If a URL is provided, it is the canonical reference to a GraphDefinition that it controls what additional resources are to be added to the Bundle when building the message. The GraphDefinition can also specify profiles that apply to the various resources.; (xsd)graph:GraphDefinition*>?🔗 Indicates what types of messages may be sent as an application-level response to this message. This indicates an application level response to "close" a transaction implicit in a particular request message. To define a complete workflow scenario, look to the [[PlanDefinition]] resource which allows the definition of complex orchestrations, conditionality, etc.MessageDefinition.allowedResponse(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A reference to the message definition that must be adhered to by this supported response.; (xsd)message:MessageDefinition*>
< Provides a description of the circumstances in which this response should be used (as opposed to one of the alternative responses).; (xsd)situation:markdown>?🔗 Identifies the resource (or resources) that are being addressed by the event. For example, the Encounter for an admit message or two Account records for a merge.MessageDefinition.focus(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The kind of resource that must be the focus for this message. Multiple focuses addressing different resources may occasionally occur. E.g. to link or unlink a resource from a particular account or encounter, etc. Binding: resource-types (required, One of the resource types defined as part of this version of FHIR.); (xsd)code>
< A profile that reflects constraints for the focal resource (and potentially for related resources). This should be present for most message definitions. However, if the message focus is only a single resource and there is no need to include referenced resources or otherwise enforce the presence of particular elements, it can be omitted.; (xsd)profile:StructureDefinition*>?
< Identifies the minimum number of resources of this type that must be pointed to by a message in order for it to be valid against this MessageDefinition.; (xsd)min:unsignedInt>
< Identifies the maximum number of resources of this type that must be pointed to by a message in order for it to be valid against this MessageDefinition.; (xsd)max:string>?🔗 The header for a message exchange that is either requesting or responding to an action. The reference(s) that are the subject of the action as well as other information related to the action are typically transmitted in a bundle in which the MessageHeader resource instance is the first resource in the bundle.MessageHeader(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< Code that identifies the event this message represents and connects it with its definition. Events defined as part of the FHIR specification are defined by the implementation. Alternatively a canonical uri to the EventDefinition. The time of the event will be found in the focus resource. The time of the message will be found in [Bundle.timestamp](bundle-definitions.html#Bundle.timestamp). Binding: (example, One of the message events defined as part of this version of FHIR.); (xsd)event:(<Coding>
|<EventDefinition>)>
[]< The destination application which the message is intended for. There SHOULD be at least one destination, but in some circumstances, the source system is unaware of any particular destination system.; (xsd)destination:MessageHeader.destination>*
< Identifies the sending system to allow the use of a trust relationship. Use case is for where a (trusted) sending system is responsible for multiple organizations, and therefore cannot differentiate based on source endpoint / authentication alone. Proposing to remove and rely on Task to convey this information.; (xsd)sender:(<Device>
|<Organization>
|<Practitioner>
|<PractitionerRole>)>?
< The logical author of the message - the personor device that decided the described event should happen. When there is more than one candidate, pick the most proximal to the MessageHeader. Can provide other authors in extensions. Usually only for the request but can be used in a response.Proposing to remove and rely on Task to convey this information. ; (xsd)author:(<Device>
|<Organization>
|<Practitioner>
|<PractitionerRole>)>?
< The source application from which this message originated.; (xsd)source:MessageHeader.source>
< The person or organization that accepts overall responsibility for the contents of the message. The implication is that the message event happened under the policies of the responsible party. Usually only for the request but can be used in a response.Proposing to remove and rely on Task to convey this information.; (xsd)responsible:(<Organization>
|<Practitioner>
|<PractitionerRole>)>?
< Coded indication of the cause for the event - indicates a reason for the occurrence of the event that is a focus of this message. Binding: message-reason-encounter (example, Reason for event occurrence.); (xsd)reason:CodeableConcept>?
< Information about the message that this message is a response to. Only present if this message is a response.; (xsd)response:MessageHeader.response>?
[]< The actual data of the message - a reference to the root/focus class of the event. This is allowed to be a Parameters resource. The data is defined where the transaction type is defined. The transaction data is always included in the bundle that is the full message. Only the root resource is specified. The resources it references should be contained in the bundle but are not also listed here. Multiple repetitions are allowed to cater for merges and other situations with multiple focal targets.; (xsd)focus:Resource*>*
< Permanent link to the MessageDefinition for this message.; (xsd)definition:MessageDefinition*>?🔗 The destination application which the message is intended for. There SHOULD be at least one destination, but in some circumstances, the source system is unaware of any particular destination system.MessageHeader.destination(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Indicates where the message should be routed. The url may be a non-resolvable URI for systems that do not use standard network-based addresses.; (xsd)endpoint:(<Endpoint>
|<url>)>?
< Human-readable name for the target system.; (xsd)name:string>?
< Identifies the target end system in situations where the initial message transmission is to an intermediary system.; (xsd)target:Device*>?
< Allows data conveyed by a message to be addressed to a particular person or department when routing to a specific application isn't sufficient.; (xsd)receiver:(<Organization>
|<Practitioner>
|<PractitionerRole>)>?🔗 Information about the message that this message is a response to. Only present if this message is a response.MessageHeader.response(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The Bundle.identifier of the message to which this message is a response.; (xsd)identifier:Identifier>
< Code that identifies the type of response to the message - whether it was successful or not, and whether it should be resent or not. This is a generic response to the request message. Specific data for the response will be found in MessageHeader.focus. Binding: response-code (required, The kind of response to a message.); (xsd)code>
< Full details of any issues found in the message. This SHALL be contained in the bundle. If any of the issues are errors, the response code SHALL be an error.; (xsd)details:OperationOutcome*>?🔗 The source application from which this message originated.MessageHeader.source(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Identifies the routing target to send acknowledgements to. The url may be a non-resolvable URI for systems that do not use standard network-based addresses.; (xsd)endpoint:(<Endpoint>
|<url>)>?
< Human-readable name for the source system.; (xsd)name:string>?
< May include configuration or other information useful in debugging.; (xsd)software:string>?
< Can convey versions of multiple systems in situations where a message passes through multiple hands.; (xsd)version:string>?
< An e-mail, phone, website or other contact point to use to resolve issues with message communications.; (xsd)contact:ContactPoint>?🔗 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(xsd)(doc)=
<#base:DataType>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< 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.; (xsd)versionId:id>?
< When the resource last changed - e.g. when the version changed. This element is generally omitted in instances submitted in a PUT or POST. Instead, it is populated in the response instance and when retrieving information using a GET. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a [read](http.html#read) interaction.; (xsd)lastUpdated:instant>?
< 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. The exact use of the source (and the possible implied Provenance.entity.role and agent.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. The source may correspond to Provenance.entity.what[x] or Provenance.agent.who[x], though it may be a more general or abstract reference.
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.; (xsd)source:uri>?
[]< 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.; (xsd)profile:StructureDefinition*>*
[]< 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. Binding: security-labels (extensible, Security Labels from the Healthcare Privacy and Security Classification System.); (xsd)security:Coding>*
[]< 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. Binding: common-tags (example, Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".); (xsd)tag:Coding>*🔗 Common Interface declaration for conformance and knowledge artifact resources.MetadataResource(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< An absolute URI that is used to identify this {{title}} when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this {{title}} is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the {{title}} is stored on different servers. Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.
The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions).
In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.; (xsd)url:uri>?
[]< A formal identifier that is used to identify this {{title}} when it is represented in other formats, or referenced in a specification, model, design or an instance. Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this {{title}} outside of FHIR, where it is not possible to use the logical URI.; (xsd)identifier:Identifier>*
< The identifier that is used to identify this version of the {{title}} when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the {{title}} author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence without additional knowledge. (See the versionAlgorithm element.) There may be different {{title}}s that have the same url but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the {{title}} with the format [url]|[version]. The version SHOULD NOT contain a '#' - see [Business Version](resource.html#bv-format).; (xsd)version:string>?
< Indicates the mechanism used to compare versions to determine which is more current. If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined. Binding: version-algorithm (extensible, ); (xsd)versionAlgorithm:(<Coding>
|<string>)>?
< A natural language name identifying the {{title}}. This name should be usable as an identifier for the resource by machine processing applications such as code generation. The name is not expected to be globally unique. The name should be a simple alphanumeric type no-whitespace name to ensure that it is machine-processing friendly.; (xsd)name:string>?
< A short, descriptive, user-friendly title for the {{title}}. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.; (xsd)title:string>?
< The current state of this {{title}}. A nominal state-transition diagram can be found in the [Definition pattern](definition.html#statemachine) documentation.
Unknown does not represent 'other' - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization). Binding: publication-status (required, The lifecycle status of an artifact.); (xsd)status:code>
< A Boolean value to indicate that this {{title}} is authored for testing purposes (or education/evaluation/marketing) and is not intended for genuine usage. Allows filtering of {{title}}s that are appropriate for use versus not.; (xsd)experimental:boolean>?
< The date (and optionally time) when the {{title}} was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the {{title}} changes. The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the {{title}}. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)date:dateTime>?
< The name of the organization or individual responsible for the release and ongoing maintenance of the {{title}}. Usually an organization but may be an individual. The publisher (or steward) of the {{title}} is the organization or individual primarily responsible for the maintenance and upkeep of the {{title}}. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the {{title}}. This item SHOULD be populated unless the information is available from context.; (xsd)publisher:string>?
[]< Contact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)contact:ContactDetail>*
< A free text natural language description of the {{title}} from a consumer's perspective. This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the {{title}} as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context.; (xsd)description:markdown>?
[]< The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate {{title}}s. When multiple useContexts are specified, there is no expectation that all or even any of the contexts apply.; (xsd)useContext:UsageContext>*
[]< A legal or geographic region in which the {{title}} is intended to be used. It may be possible for the {{title}} to be used in jurisdictions other than those for which it was originally designed or intended.
DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.) Binding: jurisdiction (extensible, Countries and regions within which this artifact is targeted for use.); (xsd)jurisdiction:CodeableConcept>*
< Explanation of why this {{title}} is needed and why it has been designed as it has. This element does not describe the usage of the {{title}}. Instead, it provides traceability of "why" the resource is either needed or "why" it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this {{title}}.; (xsd)purpose:markdown>?
< A copyright statement relating to the {{title}} and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the {{title}}. The short copyright declaration (e.g. (c) '2015+ xyz organization' should be sent in the copyrightLabel element.; (xsd)copyright:markdown>?
< A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved'). The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.; (xsd)copyrightLabel:string>?
< The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)approvalDate:date>?
< The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. If specified, this date follows the original approval date.; (xsd)lastReviewDate:date>?
< The period during which the {{title}} content was or is planned to be in active use. The effective period for a {{title}} determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 might be published in 2015.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)effectivePeriod:Period>?
[]< Descriptive topics related to the content of the {{title}}. Topics provide a high-level categorization as well as keywords for the {{title}} that can be useful for filtering and searching. This element provides topical categorization and keywords for the {{title}}, as opposed to the more structured context-of-use information provided in the useContext element.
DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'topic' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#topic and useContext.valueCodeableConcept indicating the topic) Binding: definition-topic (example, ); (xsd)topic:CodeableConcept>*
[]< An individiual or organization primarily involved in the creation and maintenance of the {{title}}.; (xsd)author:ContactDetail>*
[]< An individual or organization primarily responsible for internal coherence of the {{title}}.; (xsd)editor:ContactDetail>*
[]< An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the {{title}}. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)reviewer:ContactDetail>*
[]< An individual or organization asserted by the publisher to be responsible for officially endorsing the {{title}} for use in some setting. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)endorser:ContactDetail>*
[]< Related artifacts such as additional documentation, justification, dependencies, bibliographic references, and predecessor and successor artifacts. Each related artifact is either an attachment, or a reference to another resource, but not both.; (xsd)relatedArtifact:RelatedArtifact>*🔗 The Library resource is a general-purpose container for knowledge asset definitions. It can be used to describe and expose existing knowledge assets such as logic libraries and information model descriptions, as well as to describe a collection of knowledge assets.modelinfolibrary(xsd)(doc)=
<#base:shareablelibrary>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< An Extension; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< An absolute URI that is used to identify this library when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this library is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the library is stored on different servers. Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.
The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions).
In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.; (xsd)url:uri>
[]< A formal identifier that is used to identify this library when it is represented in other formats, or referenced in a specification, model, design or an instance. e.g. CMS or NQF identifiers for a measure artifact. Note that at least one identifier is required for non-experimental active artifacts. Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this library outside of FHIR, where it is not possible to use the logical URI.; (xsd)identifier:Identifier>*
< The identifier that is used to identify this version of the library when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the library author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts. There may be different library instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the library with the format [url]|[version]. The version SHOULD NOT contain a '#' - see [Business Version](resource.html#bv-format).; (xsd)version:string>
< Indicates the mechanism used to compare versions to determine which is more current. If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined. Binding: version-algorithm (extensible, ); (xsd)versionAlgorithm:(<Coding>
|<string>)>?
< A natural language name identifying the library. This name should be usable as an identifier for the module by machine processing applications such as code generation. The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.; (xsd)name:string>?
< A short, descriptive, user-friendly title for the library. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.; (xsd)title:string>
< An explanatory or alternate title for the library giving additional information about its content.; (xsd)subtitle:string>?
< The status of this library. Enables tracking the life-cycle of the content. Allows filtering of libraries that are appropriate for use vs. not.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization). Binding: publication-status (required, The lifecycle status of an artifact.); (xsd)status:code>
< A Boolean value to indicate that this library is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. Allows filtering of librarys that are appropriate for use versus not.; (xsd)experimental:boolean>?
< Identifies the type of library such as a Logic Library, Model Definition, Asset Collection, or Module Definition. Binding: library-type (extensible, The type of knowledge asset this library contains.); (xsd)type:CodeableConcept>
< A code or group definition that describes the intended subject of the contents of the library. Binding: participant-resource-types (extensible, The possible types of subjects for a library (E.g. Patient, Practitioner, Organization, Location, etc.).); (xsd)subject:(<CodeableConcept>
|<Group>)>?
< The date (and optionally time) when the library was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the library changes. The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the library. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)date:dateTime>?
< The name of the organization or individual responsible for the release and ongoing maintenance of the library. Usually an organization but may be an individual. The publisher (or steward) of the library is the organization or individual primarily responsible for the maintenance and upkeep of the library. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the library. This item SHOULD be populated unless the information is available from context.; (xsd)publisher:string>?
[]< Contact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)contact:ContactDetail>*
< A free text natural language description of the library from a consumer's perspective. This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the library as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the library is presumed to be the predominant language in the place the library was created).; (xsd)description:markdown>
[]< The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate library instances. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.; (xsd)useContext:UsageContext>*
[]< A legal or geographic region in which the library is intended to be used. It may be possible for the library to be used in jurisdictions other than those for which it was originally designed or intended.
DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.) Binding: jurisdiction (extensible, Countries and regions within which this artifact is targeted for use.); (xsd)jurisdiction:CodeableConcept>*
< Explanation of why this library is needed and why it has been designed as it has. This element does not describe the usage of the library. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this library.; (xsd)purpose:markdown>?
< A detailed description of how the library is used from a clinical perspective.; (xsd)usage:markdown>?
< A copyright statement relating to the library and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the library. The short copyright declaration (e.g. (c) '2015+ xyz organization' should be sent in the copyrightLabel element.; (xsd)copyright:markdown>?
< A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved'). The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.; (xsd)copyrightLabel:string>?
< The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)approvalDate:date>?
< The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. If specified, this date follows the original approval date.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)lastReviewDate:date>?
< The period during which the library content was or is planned to be in active use. The effective period for a library determines when the content is applicable for usage and is independent of publication and review dates. For example, a library intended to be used for the year 2016 might be published in 2015.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)effectivePeriod:Period>?
[]< Descriptive topics related to the content of the library. Topics provide a high-level categorization of the library that can be useful for filtering and searching. DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'topic' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#topic and useContext.valueCodeableConcept indicating the topic) Binding: definition-topic (example, High-level categorization of the definition, used for searching, sorting, and filtering.); (xsd)topic:CodeableConcept>*
[]< An individiual or organization primarily involved in the creation and maintenance of the content.; (xsd)author:ContactDetail>*
[]< An individual or organization primarily responsible for internal coherence of the content.; (xsd)editor:ContactDetail>*
[]< An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the content. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)reviewer:ContactDetail>*
[]< An individual or organization asserted by the publisher to be responsible for officially endorsing the content for use in some setting. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)endorser:ContactDetail>*
[]< Related artifacts such as additional documentation, justification, or bibliographic references. Each related artifact is either an attachment, or a reference to another resource, but not both.; (xsd)relatedArtifact:RelatedArtifact>*
[]< The parameter element defines parameters used by the library.; (xsd)parameter:ParameterDefinition>*
[]< Describes a set of data that must be provided in order to be able to successfully perform the computations defined by the library.; (xsd)dataRequirement:DataRequirement>*
[]< The content of the library as an Attachment. The content may be a reference to a url, or may be directly embedded as a base-64 string. Either way, the contentType of the attachment determines how to interpret the content.; (xsd)content:Attachment>*
[]< Defines a knowledge capability afforded by this knowledge artifact.; (xsd)knowledgeCapability:Extension>*
[]< Defines a knowledge representation level provided by this knowledge artifact.; (xsd)knowledgeRepresentationLevel:Extension>*
[]< A comment containing additional documentation, a review comment, usage guidance, or other relevant information from a particular user.; (xsd)artifactComment:Extension>*
[]< The XML representation of the ModelInfo as base-64 encoded data.; (xsd)modelInfoXmlContent:modelinfolibrary.modelInfoXmlContent>*
[]< The JSON representation of the ModelInfo as base-64 encoded data.; (xsd)modelInfoJsonContent:modelinfolibrary.modelInfoJsonContent>*🔗 The JSON representation of the ModelInfo as base-64 encoded data.modelinfolibrary.modelInfoJsonContent(xsd)(doc)=
<#base:Attachment>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< 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. Binding: mimetypes (required, BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)) application/json; (xsd)contentType:code>?
< The human language of the content. The value can be any valid value according to BCP 47. Binding: all-languages (required, IETF language tag for a human language.); (xsd)language:code>?
< 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.; (xsd)data:base64Binary>
< 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.; (xsd)url>?
< 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.; (xsd)size:integer64>?
< 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.; (xsd)hash:base64Binary>?
< A label or set of text to display in place of the data. May sometimes be derived from the source filename.; (xsd)title:string>?
< The date that the attachment was first created.; (xsd)creation:dateTime>?
< Height of the image in pixels (photo/video).; (xsd)height:positiveInt>?
< Width of the image in pixels (photo/video).; (xsd)width:positiveInt>?
< The number of frames in a photo. This is used with a multi-page fax, or an imaging acquisition context that takes multiple slices in a single image, or an animated gif. If there is more than one frame, this SHALL have a value in order to alert interface software that a multi-frame capable rendering widget is required. if the number of frames is not supplied, the value may be unknown. Applications should not assume that there is only one frame unless it is explicitly stated.; (xsd)frames:positiveInt>?
< The duration of the recording in seconds - for audio and video. The duration might differ from occurrencePeriod if recording was paused.; (xsd)duration:decimal>?
< The number of pages when printed.; (xsd)pages:positiveInt>?🔗 The XML representation of the ModelInfo as base-64 encoded data.modelinfolibrary.modelInfoXmlContent(xsd)(doc)=
<#base:Attachment>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< 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. Binding: mimetypes (required, BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)) application/xml; (xsd)contentType:code>?
< The human language of the content. The value can be any valid value according to BCP 47. Binding: all-languages (required, IETF language tag for a human language.); (xsd)language:code>?
< 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.; (xsd)data:base64Binary>
< 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.; (xsd)url>?
< 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.; (xsd)size:integer64>?
< 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.; (xsd)hash:base64Binary>?
< A label or set of text to display in place of the data. May sometimes be derived from the source filename.; (xsd)title:string>?
< The date that the attachment was first created.; (xsd)creation:dateTime>?
< Height of the image in pixels (photo/video).; (xsd)height:positiveInt>?
< Width of the image in pixels (photo/video).; (xsd)width:positiveInt>?
< The number of frames in a photo. This is used with a multi-page fax, or an imaging acquisition context that takes multiple slices in a single image, or an animated gif. If there is more than one frame, this SHALL have a value in order to alert interface software that a multi-frame capable rendering widget is required. if the number of frames is not supplied, the value may be unknown. Applications should not assume that there is only one frame unless it is explicitly stated.; (xsd)frames:positiveInt>?
< The duration of the recording in seconds - for audio and video. The duration might differ from occurrencePeriod if recording was paused.; (xsd)duration:decimal>?
< The number of pages when printed.; (xsd)pages:positiveInt>?🔗 The Library resource is a general-purpose container for knowledge asset definitions. It can be used to describe and expose existing knowledge assets such as logic libraries and information model descriptions, as well as to describe a collection of knowledge assets.moduledefinitionlibrary(xsd)(doc)=
<#base:shareablelibrary>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< An Extension; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< An absolute URI that is used to identify this library when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this library is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the library is stored on different servers. Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.
The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions).
In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.; (xsd)url:uri>
[]< A formal identifier that is used to identify this library when it is represented in other formats, or referenced in a specification, model, design or an instance. e.g. CMS or NQF identifiers for a measure artifact. Note that at least one identifier is required for non-experimental active artifacts. Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this library outside of FHIR, where it is not possible to use the logical URI.; (xsd)identifier:Identifier>*
< The identifier that is used to identify this version of the library when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the library author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts. There may be different library instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the library with the format [url]|[version]. The version SHOULD NOT contain a '#' - see [Business Version](resource.html#bv-format).; (xsd)version:string>
< Indicates the mechanism used to compare versions to determine which is more current. If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined. Binding: version-algorithm (extensible, ); (xsd)versionAlgorithm:(<Coding>
|<string>)>?
< A natural language name identifying the library. This name should be usable as an identifier for the module by machine processing applications such as code generation. The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.; (xsd)name:string>?
< A short, descriptive, user-friendly title for the library. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.; (xsd)title:string>
< An explanatory or alternate title for the library giving additional information about its content.; (xsd)subtitle:string>?
< The status of this library. Enables tracking the life-cycle of the content. Allows filtering of libraries that are appropriate for use vs. not.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization). Binding: publication-status (required, The lifecycle status of an artifact.); (xsd)status:code>
< A Boolean value to indicate that this library is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. Allows filtering of librarys that are appropriate for use versus not.; (xsd)experimental:boolean>?
< Identifies the type of library such as a Logic Library, Model Definition, Asset Collection, or Module Definition. Binding: library-type (extensible, The type of knowledge asset this library contains.); (xsd)type:CodeableConcept>
< A code or group definition that describes the intended subject of the contents of the library. Binding: participant-resource-types (extensible, The possible types of subjects for a library (E.g. Patient, Practitioner, Organization, Location, etc.).); (xsd)subject:(<CodeableConcept>
|<Group>)>?
< The date (and optionally time) when the library was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the library changes. The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the library. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)date:dateTime>?
< The name of the organization or individual responsible for the release and ongoing maintenance of the library. Usually an organization but may be an individual. The publisher (or steward) of the library is the organization or individual primarily responsible for the maintenance and upkeep of the library. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the library. This item SHOULD be populated unless the information is available from context.; (xsd)publisher:string>?
[]< Contact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)contact:ContactDetail>*
< A free text natural language description of the library from a consumer's perspective. This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the library as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the library is presumed to be the predominant language in the place the library was created).; (xsd)description:markdown>
[]< The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate library instances. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.; (xsd)useContext:UsageContext>*
[]< A legal or geographic region in which the library is intended to be used. It may be possible for the library to be used in jurisdictions other than those for which it was originally designed or intended.
DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.) Binding: jurisdiction (extensible, Countries and regions within which this artifact is targeted for use.); (xsd)jurisdiction:CodeableConcept>*
< Explanation of why this library is needed and why it has been designed as it has. This element does not describe the usage of the library. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this library.; (xsd)purpose:markdown>?
< A detailed description of how the library is used from a clinical perspective.; (xsd)usage:markdown>?
< A copyright statement relating to the library and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the library. The short copyright declaration (e.g. (c) '2015+ xyz organization' should be sent in the copyrightLabel element.; (xsd)copyright:markdown>?
< A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved'). The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.; (xsd)copyrightLabel:string>?
< The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)approvalDate:date>?
< The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. If specified, this date follows the original approval date.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)lastReviewDate:date>?
< The period during which the library content was or is planned to be in active use. The effective period for a library determines when the content is applicable for usage and is independent of publication and review dates. For example, a library intended to be used for the year 2016 might be published in 2015.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)effectivePeriod:Period>?
[]< Descriptive topics related to the content of the library. Topics provide a high-level categorization of the library that can be useful for filtering and searching. DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'topic' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#topic and useContext.valueCodeableConcept indicating the topic) Binding: definition-topic (example, High-level categorization of the definition, used for searching, sorting, and filtering.); (xsd)topic:CodeableConcept>*
[]< An individiual or organization primarily involved in the creation and maintenance of the content.; (xsd)author:ContactDetail>*
[]< An individual or organization primarily responsible for internal coherence of the content.; (xsd)editor:ContactDetail>*
[]< An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the content. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)reviewer:ContactDetail>*
[]< An individual or organization asserted by the publisher to be responsible for officially endorsing the content for use in some setting. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)endorser:ContactDetail>*
[]< Related artifacts such as additional documentation, justification, or bibliographic references. Each related artifact is either an attachment, or a reference to another resource, but not both.; (xsd)relatedArtifact:RelatedArtifact>*
[]< The parameter element defines parameters used by the library.; (xsd)parameter:ParameterDefinition>*
[]< Describes a set of data that must be provided in order to be able to successfully perform the computations defined by the library.; (xsd)dataRequirement:DataRequirement>*
< The content of the library as an Attachment. The content may be a reference to a url, or may be directly embedded as a base-64 string. Either way, the contentType of the attachment determines how to interpret the content.; (xsd)content:Attachment>{0,0}
[]< Defines a knowledge capability afforded by this knowledge artifact.; (xsd)knowledgeCapability:Extension>*
[]< Defines a knowledge representation level provided by this knowledge artifact.; (xsd)knowledgeRepresentationLevel:Extension>*
[]< A comment containing additional documentation, a review comment, usage guidance, or other relevant information from a particular user.; (xsd)artifactComment:Extension>*
< Specifies the input parameters to the operation (such as a test case description or a data requirements or evaluate operation).; (xsd)inputParameters:Extension>?
[]< Defines a code directly referenced by artifact logic, as opposed to a value set. Direct reference codes may be the target of data requirements.; (xsd)directReferenceCode:Extension>*
[]< Represents a specific logic definition used by the artifact.; (xsd)logicDefinition:Extension>*
[]< Related artifacts such as additional documentation, justification, or bibliographic references. Each related artifact is either an attachment, or a reference to another resource, but not both.; (xsd)dependency:moduledefinitionlibrary.dependency>*🔗 Related artifacts such as additional documentation, justification, or bibliographic references. Each related artifact is either an attachment, or a reference to another resource, but not both.moduledefinitionlibrary.dependency(xsd)(doc)=
<#base:RelatedArtifact>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< The type of relationship to the related artifact. The presence of both sides of a relationship type (e.g. successor and predecessor) is required to support use cases where one side of a relationship is not represented in FHIR. However, this feature SHALL NOT be used to create bi-directional resource links in FHIR instances. Specifically, following the methodology of "new points to old" and "many points to one", when using related artifact elements to describe and reference FHIR resources, the type element SHALL be drawn from the fhir-related-artifact-type ValueSet. Binding: related-artifact-type (required, The type of relationship to the related artifact.) depends-on; (xsd)type:code>
[]< Provides additional classifiers of the related artifact. Binding: citation-artifact-classifier (example, Additional classifiers for the related artifact.); (xsd)classifier:CodeableConcept>*
< A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index.; (xsd)label:string>?
< A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.; (xsd)display:string>?
< 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.; (xsd)citation:markdown>?
< The document being referenced, represented as an attachment. This is exclusive with the resource element.; (xsd)document:Attachment>?
< The related artifact, 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.; (xsd)resource:(<CodeSystem>
|<Library>
|<ValueSet>)>
< The related artifact, if the artifact is not a canonical resource, or a resource reference to a canonical resource. If both resource and resourceReference are present, they SHOULD be consistent and reference the same resource. Although relatedArtifact is intended to support references to definitional resources, there are cases where non-definitional resources can be definitional (such as Location where the kind is mode). Related artifacts SHOULD be used to reference definitional resources, and profiles SHOULD be used to make that explicit for particular use cases.; (xsd)resourceReference:Resource*>?
< The publication status of the artifact being referred to. Binding: publication-status (required, Publication status of an artifact being referred to.); (xsd)publicationStatus:code>?
< The date of publication of the artifact being referred to.; (xsd)publicationDate:date>?🔗 Representation of a molecular sequence.MolecularSequence(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< A unique identifier for this particular sequence instance.; (xsd)identifier:Identifier>*
< Amino Acid Sequence/ DNA Sequence / RNA Sequence. Binding: sequence-type (required, Type if a sequence -- DNA, RNA, or amino acid sequence.); (xsd)type:code>?
< Indicates the subject this sequence is associated too.; (xsd)subject:(<BiologicallyDerivedProduct>
|<Group>
|<NutritionProduct>
|<Patient>
|<Substance>)>?
[]< The actual focus of a molecular sequence when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, child, or sibling. For example, in trio testing, the subject would be the child (proband) and the focus would be the parent.; (xsd)focus:Resource*>*
< Specimen used for sequencing.; (xsd)specimen:Specimen*>?
< The method for sequencing, for example, chip information.; (xsd)device:Device*>?
< The organization or lab that should be responsible for this result.; (xsd)performer:Organization*>?
< Sequence that was observed.; (xsd)literal:string>?
[]< Sequence that was observed as file content. Can be an actual file contents, or referenced by a URL to an external system.; (xsd)formatted:Attachment>*
[]< A sequence defined relative to another sequence.; (xsd)relative:MolecularSequence.relative>*🔗 A sequence defined relative to another sequence.MolecularSequence.relative(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< These are different ways of identifying nucleotides or amino acids within a sequence. Different databases and file types may use different systems. For detail definitions, see https://loinc.org/92822-6/ for more detail. Binding: http://loinc.org/LL5323-2/ (extensible, Genomic coordinate system.); (xsd)coordinateSystem:CodeableConcept>
< Indicates the order in which the sequence should be considered when putting multiple 'relative' elements together.; (xsd)ordinalPosition:integer>?
< Indicates the nucleotide range in the composed sequence when multiple 'relative' elements are used together.; (xsd)sequenceRange:Range>?
< A sequence that is used as a starting sequence to describe variants that are present in a sequence analyzed.; (xsd)startingSequence:MolecularSequence.relative.startingSequence>?
[]< Changes in sequence from the starting sequence.; (xsd)edit:MolecularSequence.relative.edit>*🔗 Changes in sequence from the starting sequence.MolecularSequence.relative.edit(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Start position of the edit on the starting sequence. If the coordinate system is either 0-based or 1-based, then start position is inclusive.; (xsd)start:integer>?
< End position of the edit on the starting sequence. If the coordinate system is 0-based then end is exclusive and does not include the last position. If the coordinate system is 1-base, then end is inclusive and includes the last position.; (xsd)end:integer>?
< Allele that was observed. Nucleotide(s)/amino acids from start position of sequence to stop position of sequence on the positive (+) strand of the observed sequence. When the sequence type is DNA, it should be the sequence on the positive (+) strand. This will lay in the range between variant.start and variant.end.; (xsd)replacementSequence:string>?
< Allele in the starting sequence. Nucleotide(s)/amino acids from start position of sequence to stop position of sequence on the positive (+) strand of the starting sequence. When the sequence type is DNA, it should be the sequence on the positive (+) strand. This will lay in the range between variant.start and variant.end.; (xsd)replacedSequence:string>?🔗 A sequence that is used as a starting sequence to describe variants that are present in a sequence analyzed.MolecularSequence.relative.startingSequence(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The genome assembly used for starting sequence, e.g. GRCh38. Binding: http://loinc.org/LL1040-6/ (extensible, Human reference sequence NCBI build ID.); (xsd)genomeAssembly:CodeableConcept>?
< Structural unit composed of a nucleic acid molecule which controls its own replication through the interaction of specific proteins at one or more origins of replication ([SO:0000340](http://www.sequenceontology.org/browser/current_svn/term/SO:0000340)). Binding: http://loinc.org/LL2938-0/|5.0.0 (required, The chromosome containing the sequence.); (xsd)chromosome:CodeableConcept>?
< The reference sequence that represents the starting sequence. A starting sequence may be represented in one of three ways:
1. CodeableConcept, using NCBI, LRG or other appropriate code systems
1. a simple string of IUPAC codes
1. a reference to another MolecularSequence resource. Binding: (example, Multiple bindings acceptable (NCBI or LRG)); (xsd)sequence:(<CodeableConcept>
|<MolecularSequence>
|<string>)>?
< Start position of the window on the starting sequence. This value should honor the rules of the coordinateSystem.; (xsd)windowStart:integer>?
< End position of the window on the starting sequence. This value should honor the rules of the coordinateSystem.; (xsd)windowEnd:integer>?
< A relative reference to a DNA strand based on gene orientation. The strand that contains the open reading frame of the gene is the "sense" strand, and the opposite complementary strand is the "antisense" strand. Binding: orientation-type (required, Type for orientation); (xsd)orientation:code>?
< An absolute reference to a strand. The Watson strand is the strand whose 5'-end is on the short arm of the chromosome, and the Crick strand as the one whose 5'-end is on the long arm. Binding: strand-type (required, Type for strand); (xsd)strand:code>?🔗 Availability data for an {item}.MonetaryComponent(xsd)(doc)=
<#base:DataType>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< base | surcharge | deduction | discount | tax | informational. Binding: price-component-type (required, The purpose for which an extended contact detail should be used.); (xsd)type:code>
< Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc. Binding: (example, Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc.); (xsd)code:CodeableConcept>?
< Factor used for calculating this component.; (xsd)factor:decimal>?
< Explicit value amount to be used.; (xsd)amount:Money>?🔗 An amount of economic utility in some recognized currency.Money(xsd)(doc)=
<#base:DataType>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< Numerical value (with implicit precision). Monetary values have their own rules for handling precision (refer to standard accounting text books).; (xsd)value:decimal>?
< ISO 4217 Currency Code. Binding: currencies (required, A code indicating the currency, taken from ISO 4217.); (xsd)currency:code>?🔗 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.MoneyQuantity(xsd)(doc)=
<#base:Quantity>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< 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).; (xsd)value:decimal>?
< 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. Binding: quantity-comparator (required, How the Quantity should be understood and represented.); (xsd)comparator:code>?
< A human-readable form of the unit.; (xsd)unit:string>?
< The identification of the system that provides the coded form of the unit.; (xsd)system:uri>?
< 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.; (xsd)code>?🔗 A curated namespace that issues unique symbols within that namespace for the identification of concepts, people, devices, etc. Represents a "System" used within the Identifier and Coding data types.NamingSystem(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< An absolute URI that is used to identify this naming system when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this naming system is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the naming system is stored on different servers. Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.
The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions).
In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.; (xsd)url:uri>?
[]< A formal identifier that is used to identify this naming system when it is represented in other formats, or referenced in a specification, model, design or an instance. Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this naming system outside of FHIR, where it is not possible to use the logical URI.; (xsd)identifier:Identifier>*
< The identifier that is used to identify this version of the naming system when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the naming system author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. There may be different naming system instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the naming system with the format [url]|[version]. The version SHOULD NOT contain a '#' - see [Business Version](resource.html#bv-format).; (xsd)version:string>?
< Indicates the mechanism used to compare versions to determine which NamingSystem is more current. If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined. Binding: version-algorithm (extensible, ); (xsd)versionAlgorithm:(<Coding>
|<string>)>?
< A natural language name identifying the naming system. This name should be usable as an identifier for the module by machine processing applications such as code generation. The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.The"symbolic name" for an OID would be captured as an extension.; (xsd)name:string>
< A short, descriptive, user-friendly title for the naming system. This title does not need to be machine-processing friendly and may contain punctuation, white-space, etc.; (xsd)title:string>?
< The status of this naming system. Enables tracking the life-cycle of the content. Allows filtering of naming systems that are appropriate for use versus not.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization). Binding: publication-status (required, The lifecycle status of an artifact.); (xsd)status:code>
< Indicates the purpose for the naming system - what kinds of things does it make unique? Binding: namingsystem-type (required, Identifies the purpose of the naming system.); (xsd)kind:code>
< A Boolean value to indicate that this naming system is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. Allows filtering of naming systems that are appropriate for use versus not.; (xsd)experimental:boolean>?
< The date (and optionally time) when the naming system was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the naming system changes. The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the naming system. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)date:dateTime>
< The name of the organization or individual responsible for the release and ongoing maintenance of the naming system. Usually an organization but may be an individual. The publisher (or steward) of the naming system is the organization or individual primarily responsible for the maintenance and upkeep of the naming system. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the naming system. This item SHOULD be populated unless the information is available from context.; (xsd)publisher:string>?
[]< Contact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)contact:ContactDetail>*
< The name of the organization that is responsible for issuing identifiers or codes for this namespace and ensuring their non-collision. This is the primary organization. Responsibility for some aspects of a namespace may be delegated.; (xsd)responsible:string>?
< Categorizes a naming system for easier search by grouping related naming systems. This will most commonly be used for identifier namespaces, but categories could potentially be useful for code systems and authorities as well. Binding: namingsystem-identifier-system-type (preferred, A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.); (xsd)type:CodeableConcept>?
< A free text natural language description of the naming system from a consumer's perspective. Details about what the namespace identifies including scope, granularity, version labeling, etc. This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the naming system as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the naming system is presumed to be the predominant language in the place the naming system was created).; (xsd)description:markdown>?
[]< The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate naming system instances. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.; (xsd)useContext:UsageContext>*
[]< A legal or geographic region in which the naming system is intended to be used. It may be possible for the naming system to be used in jurisdictions other than those for which it was originally designed or intended.
DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.) Binding: jurisdiction (extensible, Countries and regions within which this artifact is targeted for use.); (xsd)jurisdiction:CodeableConcept>*
< Explanation of why this naming system is needed and why it has been designed as it has. This element does not describe the usage of the code system. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this code system.; (xsd)purpose:markdown>?
< A copyright statement relating to the naming system and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the naming system.; (xsd)copyright:markdown>?
< A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved'). The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.; (xsd)copyrightLabel:string>?
< The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)approvalDate:date>?
< The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. If specified, this date follows the original approval date.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)lastReviewDate:date>?
< The period during which the NamingSystem content was or is planned to be in active use. The effective period for a NamingSystem determines when the content is applicable for usage and is independent of publication and review dates. For example, a NamingSystem intended to be used for the year 2016 might be published in 2015.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)effectivePeriod:Period>?
[]< Descriptions related to the content of the NamingSystem. Topics provide a high-level categorization as well as keywords for the NamingSystem that can be useful for filtering and searching. DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'topic' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#topic and useContext.valueCodeableConcept indicating the topic) Binding: definition-topic (example, ); (xsd)topic:CodeableConcept>*
[]< An individiual or organization primarily involved in the creation and maintenance of the NamingSystem.; (xsd)author:ContactDetail>*
[]< An individual or organization primarily responsible for internal coherence of the NamingSystem.; (xsd)editor:ContactDetail>*
[]< An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the NamingSystem. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)reviewer:ContactDetail>*
[]< An individual or organization asserted by the publisher to be responsible for officially endorsing the NamingSystem for use in some setting. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)endorser:ContactDetail>*
[]< Related artifacts such as additional documentation, justification, dependencies, bibliographic references, and predecessor and successor artifacts. Each related artifact is either an attachment, or a reference to another resource, but not both.; (xsd)relatedArtifact:RelatedArtifact>*
< Provides guidance on the use of the namespace, including the handling of formatting characters, use of upper vs. lower case, etc.; (xsd)usage:string>?
[]< Indicates how the system may be identified when referenced in electronic exchange. Multiple identifiers may exist, either due to duplicate registration, regional rules, needs of different communication technologies, etc.; (xsd)uniqueId:NamingSystem.uniqueId>+🔗 Indicates how the system may be identified when referenced in electronic exchange. Multiple identifiers may exist, either due to duplicate registration, regional rules, needs of different communication technologies, etc.NamingSystem.uniqueId(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Identifies the unique identifier scheme used for this particular identifier. Different identifier types may be used in different types of communications (OIDs for v3, URIs for FHIR, etc.). Other includes RUIDs from v3, standard v2 code name strings, etc. Preferred identifiers for the same identifier type SHOULD NOT overlap by period. Binding: namingsystem-identifier-type (required, Identifies the style of unique identifier used to identify a namespace.); (xsd)type:code>
< The string that should be sent over the wire to identify the code system or identifier system. If the value is a URI intended for use as FHIR system identifier, the URI should not contain "\" or "?" or "," since this makes escaping very difficult.; (xsd)value:string>
< Indicates whether this identifier is the "preferred" identifier of this type.; (xsd)preferred:boolean>?
< Notes about the past or intended usage of this identifier. e.g. "must be used in Germany" or "was initially published in error with this value".; (xsd)comment:string>?
< Identifies the period of time over which this identifier is considered appropriate to refer to the naming system. Outside of this window, the identifier might be non-deterministic. Within a registry, a given identifier should only be "active" for a single namespace at a time. (Ideally, an identifier should only ever be associated with a single namespace across all time).
The nuance of identifier deprecation is not represented with a separate element. When a determination is made that an identifier should not be used, the validity period end date is updated with the date the identifier is deemed to be deprecated. The identifier should no longer be used once the period end date is reached.; (xsd)period:Period>?
< Indicates whether this identifier ie endorsed by the official owner of the associated naming system.; (xsd)authoritative:boolean>?🔗 A human-readable summary of the resource conveying the essential clinical and business information for the resource.Narrative(xsd)(doc)=
<#base:DataType>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< 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. Binding: narrative-status (required, The status of a resource narrative.); (xsd)status:code>
< 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.; (xsd)div:xhtml>🔗 A record of food or fluid that is being consumed by a patient. A NutritionIntake may indicate that the patient may be consuming the food or fluid now or has consumed the food or fluid in the past. The source of this information can be the patient, significant other (such as a family member or spouse), or a clinician. A common scenario where this information is captured is during the history taking process during a patient visit or stay or through an app that tracks food or fluids consumed. The consumption information may come from sources such as the patient's memory, from a nutrition label, or from a clinician documenting observed intake.NutritionIntake(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< Identifiers associated with this Nutrition Intake that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server. This is a business identifier, not a resource identifier.; (xsd)identifier:Identifier>*
[]< Instantiates FHIR protocol or definition.; (xsd)instantiatesCanonical:(<ActivityDefinition>
|<ClinicalUseDefinition>
|<EventDefinition>
|<ChargeItemDefinition>
|<Measure>
|<MessageDefinition>
|<ObservationDefinition>
|<OperationDefinition>
|<PlanDefinition>
|<Questionnaire>
|<Requirements>
|<SubscriptionTopic>
|<TestPlan>
|<TestScript>)>*
[]< Instantiates external protocol or definition.; (xsd)instantiatesUri:uri>*
[]< A plan, proposal or order that is fulfilled in whole or in part by this event.; (xsd)basedOn:(<CarePlan>
|<NutritionOrder>
|<ServiceRequest>)>*
[]< A larger event of which this particular event is a component or step.; (xsd)partOf:(<NutritionIntake>
|<Observation>
|<Procedure>)>*
< A code representing the patient or other source's judgment about the state of the intake that this assertion is about. Generally, this will be active or completed. NutritionIntake is a statement at a point in time. The status is only representative at the point when it was asserted. The value set for NutritionIntake.status contains codes that assert the status of the consumption of the food or fluid by the patient (for example, stopped or on hold) as well as codes that assert the status of the Nutrition Intake itself (for example, entered in error).
This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. Binding: event-status (required, A coded concept indicating the current status of a NutritionIntake.); (xsd)status:code>
[]< Captures the reason for the current state of the NutritionIntake. This is generally only used for "exception" statuses such as "not-taken", "on-hold", "cancelled" or "entered-in-error". The reason for performing the event at all is captured in reasonCode, not here. Binding: clinicalimpression-status-reason (example, A coded concept indicating the reason for the status of the statement.); (xsd)statusReason:CodeableConcept>*
< Overall type of nutrition intake. Binding: diet-type (example, A coded concept identifying an overall type of diet or nutrition that is represented by this intake. See consumedItem for more details.); (xsd)code:CodeableConcept>?
< The person, animal or group who is/was consuming the food or fluid.; (xsd)subject:(<Group>
|<Patient>)>
< The encounter that establishes the context for this NutritionIntake.; (xsd)encounter:Encounter*>?
< The interval of time during which it is being asserted that the patient is/was consuming the food or fluid. This attribute reflects the period over which the patient consumed the food fluid and is expected to be populated on the majority of NutritionIntake. If the food or fluid is still being taken and is expected to continue indefinitely at the time the usage is recorded, the "end" date will be omitted. If the end date is known, then it is included as the "end date". The date/time attribute supports a variety of dates - year, year/month and exact date. If something more than this is required, this should be conveyed as text.; (xsd)occurrence:(<dateTime>
|<Period>)>?
< The date when the Nutrition Intake was asserted by the information source.; (xsd)recorded:dateTime>?
< The person or organization that provided the information about the consumption of this food or fluid. Note: Use derivedFrom when a NutritionIntake is derived from other resources.; (xsd)reported:(<boolean>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>?
[]< What food or fluid product or item was consumed.; (xsd)consumedItem:NutritionIntake.consumedItem>+
[]< Total nutrient amounts for the whole meal, product, serving, etc. Individual item nutrients are not currently included in the resource and will likely end up as a reference in nutritionProduct to represent the individual items.; (xsd)ingredientLabel:NutritionIntake.ingredientLabel>*
[]< Who performed the intake and how they were involved.; (xsd)performer:NutritionIntake.performer>*
< Where the intake occurred.; (xsd)location:Location*>?
[]< Allows linking the NutritionIntake to the underlying NutritionOrder, or to other information, such as AllergyIntolerance, that supports or is used to derive the NutritionIntake. Likely references would be to AllergyIntolerance, Observation or QuestionnaireAnswers.; (xsd)derivedFrom:Resource*>*
[]< A reason, Condition or observation for why the food or fluid is /was consumed. Binding: condition-code (example, Reason for why something was ingested.); (xsd)reason:(<Condition>
|<DiagnosticReport>
|<DocumentReference>
|<Observation>)>*
[]< Provides extra information about the Nutrition Intake that is not conveyed by the other attributes.; (xsd)note:Annotation>*🔗 What food or fluid product or item was consumed.NutritionIntake.consumedItem(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Indicates what a category of item that was consumed: e.g., food, fluid, enteral, etc. Binding: edible-substance-type (example, Types of food.); (xsd)type:CodeableConcept>
< Identifies the food or fluid product that was consumed. This is potentially a link to a resource representing the details of the food product (TBD) or a simple attribute carrying a code that identifies the food from a known list of foods. If only a code is specified, then it needs to be a code for a specific product. If more information is required, then the use of a new nutritionProduct resource is recommended. Binding: food-type (example, Specific food that can be consumed by a patient.); (xsd)nutritionProduct:NutritionProduct*>
< Scheduled frequency of consumption.; (xsd)schedule:Timing>?
< Quantity of the specified food.; (xsd)amount:SimpleQuantity>?
< Rate at which enteral feeding was administered.; (xsd)rate:SimpleQuantity>?
< Indicator when a patient is in a setting where it is helpful to know if food was not consumed, such as it was refused, held (as in tube feedings), or otherwise not provided. If a consumption is being recorded from an app, such as MyFitnessPal, this indicator will likely not be used.; (xsd)notConsumed:boolean>?
< Document the reason the food or fluid was not consumed, such as refused, held, etc. Binding: not-consumed-reason (example, Reasons for why something was not consumed.); (xsd)notConsumedReason:CodeableConcept>?🔗 Total nutrient amounts for the whole meal, product, serving, etc. Individual item nutrients are not currently included in the resource and will likely end up as a reference in nutritionProduct to represent the individual items.NutritionIntake.ingredientLabel(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Total nutrient consumed. This could be a macronutrient (protein, fat, carbohydrate), or a vitamin and mineral. Binding: nutrient-code (example, Types of nutrients that can be found in a nutrition product.); (xsd)nutrient:Substance*>
< Total amount of nutrient consumed.; (xsd)amount:SimpleQuantity>🔗 Who performed the intake and how they were involved.NutritionIntake.performer(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Type of performer. Binding: performer-role (example, Type of performance.); (xsd)function:CodeableConcept>?
< Who performed the intake.; (xsd)actor:(<CareTeam>
|<Device>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>🔗 A request to supply a diet, formula feeding (enteral) or oral nutritional supplement to a patient/resident. Referenced by an Order Request (workflow).NutritionOrder(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< Identifiers assigned to this order by the order sender or by the order receiver. The Identifier.type element can be to indicate filler vs. placer if needed. This is explained in further detail [here](servicerequest.html#notes).; (xsd)identifier:Identifier>*
[]< The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this NutritionOrder. Note: This is a business identifier, not a resource identifier (see [discussion](resource.html#identifiers)). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.; (xsd)instantiatesCanonical:(<ActivityDefinition>
|<PlanDefinition>)>*
[]< The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this NutritionOrder. This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.; (xsd)instantiatesUri:uri>*
[]< The URL pointing to a protocol, guideline, orderset or other definition that is adhered to in whole or in part by this NutritionOrder.; (xsd)instantiates:uri>*
[]< A plan or request that is fulfilled in whole or in part by this nutrition order.; (xsd)basedOn:(<CarePlan>
|<NutritionOrder>
|<ServiceRequest>)>*
< A shared identifier common to all nutrition orders that were authorized more or less simultaneously by a single author, representing the composite or group identifier.; (xsd)groupIdentifier:Identifier>?
< The workflow status of the nutrition order/request. Typically the system placing the order sets the status to "requested". Thereafter, the order is maintained by the receiver that updates the status as the request is handled. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. Binding: request-status (required, Codes identifying the lifecycle stage of the nutrition order.); (xsd)status:code>
< Indicates the level of authority/intentionality associated with the NutrionOrder and where the request fits into the workflow chain. When resources map to this element, they are free to define as many codes as necessary to cover their space and will map to "proposal, plan or order". Can have multiple codes that map to one of these. E.g. "original order", "encoded order", "reflex order" would all map to "order". Expectation is that the set of codes is mutually exclusive or a strict all-encompassing hierarchy. Binding: request-intent (required, Codes indicating the degree of authority/intentionality associated with a nutrition order.); (xsd)intent:code>
< Indicates how quickly the Nutrition Order should be addressed with respect to other requests. Binding: request-priority (required, Identifies the level of importance to be assigned to actioning the request.); (xsd)priority:code>?
< The person or set of individuals who needs the nutrition order for an oral diet, nutritional supplement and/or enteral or formula feeding.; (xsd)subject:(<Group>
|<Patient>)>
< An encounter that provides additional information about the healthcare context in which this request is made.; (xsd)encounter:Encounter*>?
[]< Information to support fulfilling (i.e. dispensing or administering) of the nutrition, for example, patient height and weight).; (xsd)supportingInformation:Resource*>*
< The date and time that this nutrition order was requested.; (xsd)dateTime>
< The practitioner that holds legal responsibility for ordering the diet, nutritional supplement, or formula feedings.; (xsd)orderer:(<Practitioner>
|<PractitionerRole>)>?
[]< The specified desired performer of the nutrition order.; (xsd)performer:(<CareTeam>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>*
[]< A link to a record of allergies or intolerances which should be included in the nutrition order. Information on a patient's food allergies and intolerances to inform healthcare personnel about the type of foods that the patient shouldn't receive or consume.; (xsd)allergyIntolerance:AllergyIntolerance*>*
[]< This modifier is used to convey order-specific modifiers about the type of food that should be given. These can be derived from patient allergies, intolerances, or preferences such as Halal, Vegan or Kosher. This modifier applies to the entire nutrition order inclusive of the oral diet, nutritional supplements and enteral formula feedings. Information on a patient's food preferences that inform healthcare personnel about the food that the patient should receive or consume. Binding: encounter-diet (example, Medical, cultural or ethical food preferences to help with catering requirements.); (xsd)foodPreferenceModifier:CodeableConcept>*
[]< This modifier is used to convey Order-specific modifier about the type of oral food or oral fluids that should not be given. These can be derived from patient allergies, intolerances, or preferences such as No Red Meat, No Soy or No Wheat or Gluten-Free. While it should not be necessary to repeat allergy or intolerance information captured in the referenced AllergyIntolerance resource in the excludeFoodModifier, this element may be used to convey additional specificity related to foods that should be eliminated from the patient’s diet for any reason. This modifier applies to the entire nutrition order inclusive of the oral diet, nutritional supplements and enteral formula feedings. Information on a patient's food allergies, intolerances and preferences to inform healthcare personnel about the type of foods that the patient shouldn't receive or consume. Binding: food-type (example, Codes used to indicate the type of food that should NOT be given to the patient.); (xsd)excludeFoodModifier:CodeableConcept>*
< This modifier is used to convey whether a food item is allowed to be brought in by the patient and/or family. If set to true, indicates that the receiving system does not need to supply the food item.; (xsd)outsideFoodAllowed:boolean>?
< Diet given orally in contrast to enteral (tube) feeding.; (xsd)oralDiet:NutritionOrder.oralDiet>?
[]< Oral nutritional products given in order to add further nutritional value to the patient's diet.; (xsd)supplement:NutritionOrder.supplement>*
< Feeding provided through the gastrointestinal tract via a tube, catheter, or stoma that delivers nutrition distal to the oral cavity.; (xsd)enteralFormula:NutritionOrder.enteralFormula>?
[]< Comments made about the {{title}} by the requester, performer, subject or other participants. This element SHALL NOT be used to supply free text instructions for the diet which are represented in the `.oralDiet.instruction`, `supplement.instruction`, or `enteralFormula.administrationInstruction` elements.; (xsd)note:Annotation>*🔗 Feeding provided through the gastrointestinal tract via a tube, catheter, or stoma that delivers nutrition distal to the oral cavity.NutritionOrder.enteralFormula(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The type of enteral or infant formula such as an adult standard formula with fiber or a soy-based infant formula. Binding: entformula-type (example, Codes for type of enteral formula to be administered to patient.); (xsd)baseFormulaType:NutritionProduct*>?
< The product or brand name of the enteral or infant formula product such as "ACME Adult Standard Formula".; (xsd)baseFormulaProductName:string>?
[]< The intended type of device that is to be used for the administration of the enteral formula.; (xsd)deliveryDevice:DeviceDefinition*>*
[]< Indicates modular components to be provided in addition or mixed with the base formula.; (xsd)additive:NutritionOrder.enteralFormula.additive>*
< The amount of energy (calories) that the formula should provide per specified volume, typically per mL or fluid oz. For example, an infant may require a formula that provides 24 calories per fluid ounce or an adult may require an enteral formula that provides 1.5 calorie/mL.; (xsd)caloricDensity:SimpleQuantity>?
< The route or physiological path of administration into the patient's gastrointestinal tract for purposes of providing the formula feeding, e.g. nasogastric tube. Binding: enteral-route (extensible, Codes specifying the route of administration of enteral formula.); (xsd)routeOfAdministration:CodeableConcept>?
[]< Formula administration instructions as structured data. This repeating structure allows for changing the administration rate or volume over time for both bolus and continuous feeding. An example of this would be an instruction to increase the rate of continuous feeding every 2 hours. See implementation notes below for further discussion on how to order continuous vs bolus enteral feeding using this resource.; (xsd)administration:NutritionOrder.enteralFormula.administration>*
< The maximum total quantity of formula that may be administered to a subject over the period of time, e.g. 1440 mL over 24 hours.; (xsd)maxVolumeToDeliver:SimpleQuantity>?
< Free text formula administration, feeding instructions or additional instructions or information. Free text dosage instructions can be used for cases where the instructions are too complex to code.; (xsd)administrationInstruction:markdown>?🔗 Indicates modular components to be provided in addition or mixed with the base formula.NutritionOrder.enteralFormula.additive(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Indicates the type of modular component such as protein, carbohydrate, fat or fiber to be provided in addition to or mixed with the base formula. Binding: entformula-additive (example, Codes for the type of modular component such as protein, carbohydrate or fiber to be provided in addition to or mixed with the base formula.); (xsd)type:NutritionProduct*>?
< The product or brand name of the type of modular component to be added to the formula.; (xsd)productName:string>?
< The amount of additive to be given in addition or to be mixed in with the base formula.; (xsd)quantity:SimpleQuantity>?🔗 Formula administration instructions as structured data. This repeating structure allows for changing the administration rate or volume over time for both bolus and continuous feeding. An example of this would be an instruction to increase the rate of continuous feeding every 2 hours. See implementation notes below for further discussion on how to order continuous vs bolus enteral feeding using this resource.NutritionOrder.enteralFormula.administration(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Schedule information for an enteral formula.; (xsd)schedule:NutritionOrder.enteralFormula.administration.schedule>?
< The volume of formula to provide to the patient per the specified administration schedule.; (xsd)quantity:SimpleQuantity>?
< The rate of administration of formula via a feeding pump, e.g. 60 mL per hour, according to the specified schedule. Ratio is used when the quantity value in the denominator is not "1", otherwise use Quantity. For example, the Ratio datatype is used for "200 mL/4 hrs" versus the Quantity datatype for "50 mL/hr".; (xsd)rate:(<Ratio>
|<SimpleQuantity>)>?🔗 Schedule information for an enteral formula.NutritionOrder.enteralFormula.administration.schedule(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< The time period and frequency at which the enteral formula should be given. The enteral formula should be given for the combination of all schedules if more than one schedule is present.; (xsd)timing:Timing>*
< Indicates whether the enteral formula is only taken when needed within a specific dosing schedule.; (xsd)asNeeded:boolean>?
< Indicates whether the enteral formula is only taken based on a precondition for taking the enteral formula. Binding: medication-as-needed-reason (example, A coded concept identifying the precondition that should be met or evaluated prior to consuming an enteral formula.); (xsd)asNeededFor:CodeableConcept>?🔗 Diet given orally in contrast to enteral (tube) feeding.NutritionOrder.oralDiet(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< The kind of diet or dietary restriction such as fiber restricted diet or diabetic diet. Binding: diet-type (example, Codes used to indicate the type of diet being ordered for a patient.); (xsd)type:CodeableConcept>*
< Schedule information for an oral diet.; (xsd)schedule:NutritionOrder.oralDiet.schedule>?
[]< Class that defines the quantity and type of nutrient modifications (for example carbohydrate, fiber or sodium) required for the oral diet.; (xsd)nutrient:NutritionOrder.oralDiet.nutrient>*
[]< Class that describes any texture modifications required for the patient to safely consume various types of solid foods.; (xsd)texture:NutritionOrder.oralDiet.texture>*
[]< The required consistency (e.g. honey-thick, nectar-thick, thin, thickened.) of liquids or fluids served to the patient. Binding: consistency-type (example, Codes used to represent the consistency of fluids and liquids provided to the patient.); (xsd)fluidConsistencyType:CodeableConcept>*
< Free text or additional instructions or information pertaining to the oral diet. Free text dosage instructions can be used for cases where the instructions are too complex to code.; (xsd)instruction:string>?🔗 Class that defines the quantity and type of nutrient modifications (for example carbohydrate, fiber or sodium) required for the oral diet.NutritionOrder.oralDiet.nutrient(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The nutrient that is being modified such as carbohydrate or sodium. Binding: nutrient-code (example, Codes for types of nutrients that are being modified such as carbohydrate or sodium.); (xsd)modifier:CodeableConcept>?
< The quantity of the specified nutrient to include in diet.; (xsd)amount:SimpleQuantity>?🔗 Schedule information for an oral diet.NutritionOrder.oralDiet.schedule(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< The time period and frequency at which the diet should be given. The diet should be given for the combination of all schedules if more than one schedule is present.; (xsd)timing:Timing>*
< Indicates whether the product is only taken when needed within a specific dosing schedule.; (xsd)asNeeded:boolean>?
< Indicates whether the product is only taken based on a precondition for taking the product. Binding: medication-as-needed-reason (example, A coded concept identifying the precondition that should be met or evaluated prior to consuming a nutrition product.); (xsd)asNeededFor:CodeableConcept>?🔗 Class that describes any texture modifications required for the patient to safely consume various types of solid foods.NutritionOrder.oralDiet.texture(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Any texture modifications (for solid foods) that should be made, e.g. easy to chew, chopped, ground, and pureed. Coupled with the foodType (Meat). Binding: texture-code (example, Codes for food consistency types or texture modifications to apply to foods.); (xsd)modifier:CodeableConcept>?
< The food type(s) (e.g. meats, all foods) that the texture modification applies to. This could be all foods types. Coupled with the `texture.modifier`; could be (All Foods). Binding: modified-foodtype (example, Codes for types of foods that are texture-modified.); (xsd)foodType:CodeableConcept>?🔗 Oral nutritional products given in order to add further nutritional value to the patient's diet.NutritionOrder.supplement(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The kind of nutritional supplement product required such as a high protein or pediatric clear liquid supplement. Binding: supplement-type (example, Codes for nutritional supplements to be provided to the patient.); (xsd)type:NutritionProduct*>?
< The product or brand name of the nutritional supplement such as "Acme Protein Shake".; (xsd)productName:string>?
< Schedule information for a supplement.; (xsd)schedule:NutritionOrder.supplement.schedule>?
< The amount of the nutritional supplement to be given.; (xsd)quantity:SimpleQuantity>?
< Free text or additional instructions or information pertaining to the oral supplement. Free text dosage instructions can be used for cases where the instructions are too complex to code.; (xsd)instruction:string>?🔗 Schedule information for a supplement.NutritionOrder.supplement.schedule(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< The time period and frequency at which the supplement should be given. The supplement should be given for the combination of all schedules if more than one schedule is present.; (xsd)timing:Timing>*
< Indicates whether the supplement is only taken when needed within a specific dosing schedule.; (xsd)asNeeded:boolean>?
< Indicates whether the supplement is only taken based on a precondition for taking the supplement. Binding: medication-as-needed-reason (example, A coded concept identifying the precondition that should be met or evaluated prior to consuming a supplement.); (xsd)asNeededFor:CodeableConcept>?🔗 A food or supplement that is consumed by patients.NutritionProduct(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< The code assigned to the product, for example a USDA NDB number, a USDA FDC ID number, or a Langual code. Binding: edible-substance-type (example, Codes identifying specific types of nutrition products.); (xsd)code:CodeableConcept>?
< The current state of the product. Unknown does not represent "other" - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is. Binding: nutritionproduct-status (required, Codes identifying the lifecycle stage of a product.); (xsd)status:code>
[]< Nutrition products can have different classifications - according to its nutritional properties, preparation methods, etc. Binding: nutrition-product-category (example, Codes identifying classes of nutrition products.); (xsd)category:CodeableConcept>*
[]< The organisation (manufacturer, representative or legal authorization holder) that is responsible for the device.; (xsd)manufacturer:Organization*>*
[]< The product's nutritional information expressed by the nutrients. Note: This is a business identifier, not a resource identifier (see [discussion](resource.html#identifiers)). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.; (xsd)nutrient:NutritionProduct.nutrient>*
[]< Ingredients contained in this product.; (xsd)ingredient:NutritionProduct.ingredient>*
[]< Allergens that are known or suspected to be a part of this nutrition product. Binding: allergen-class (example, Codes that identify substances that can be an allergen.); (xsd)knownAllergen:Substance*>*
[]< Specifies descriptive properties of the nutrition product.; (xsd)characteristic:NutritionProduct.characteristic>*
[]< Conveys instance-level information about this product item. One or several physical, countable instances or occurrences of the product.; (xsd)instance:NutritionProduct.instance>*
[]< Comments made about the product.; (xsd)note:Annotation>*🔗 Specifies descriptive properties of the nutrition product.NutritionProduct.characteristic(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A code specifying which characteristic of the product is being described (for example, colour, shape). Binding: measurement-property (example, Codes that identify properties that can be measured.); (xsd)type:CodeableConcept>
(<valueAttachment:Attachment>
|<valueBase64Binary:base64Binary>
|<valueBoolean:boolean>
|<valueCodeableConcept:CodeableConcept>
|<valueSimpleQuantity:SimpleQuantity>
|<valueString:string>)🔗 Ingredients contained in this product.NutritionProduct.ingredient(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The ingredient contained in the product.; (xsd)item:NutritionProduct*>
[]< The amount of ingredient that is in the product.; (xsd)amount:Ratio>*🔗 Conveys instance-level information about this product item. One or several physical, countable instances or occurrences of the product.NutritionProduct.instance(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The amount of items or instances that the resource considers, for instance when referring to 2 identical units together.; (xsd)quantity:SimpleQuantity>?
[]< The identifier for the physical instance, typically a serial number or manufacturer number.; (xsd)identifier:Identifier>*
< The name for the specific product.; (xsd)name:string>?
< The identification of the batch or lot of the product.; (xsd)lotNumber:string>?
< The time after which the product is no longer expected to be in proper condition, or its use is not advised or not allowed.; (xsd)expiry:dateTime>?
< The time after which the product is no longer expected to be in proper condition, or its use is not advised or not allowed.; (xsd)useBy:dateTime>?
< An identifier that supports traceability to the event during which material in this product from one or more biological entities was obtained or pooled. Necessary to support mandatory requirements for traceability from donor/source to recipient and vice versa, while also satisfying donor anonymity requirements. The element is defined consistently across BiologicallyDerivedProduct, NutritionProduct, and Device. The identifier references an event that links to a single biological entity such as a blood donor, or to multiple biological entities (e.g. when the product is an embryo or a pooled platelet product). A single biologicalSourceEvent identifier may appear on multiple products of many types derived from a single donation event or source extraction. As an example, a single donation event may provide 2 kidneys and a liver for organ transplantation, 2 corneas for eye surgery, heart valves and arterial tissue for cardiovascular surgery, multiple skin grafts, tendons, multiple shaped bone grafts and a large number of bone putty/paste products; and each of them may be assigned to the same biological source event identifier.; (xsd)biologicalSourceEvent:Identifier>?🔗 The product's nutritional information expressed by the nutrients. Note: This is a business identifier, not a resource identifier (see [discussion](resource.html#identifiers)). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.NutritionProduct.nutrient(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The (relevant) nutrients in the product. Binding: nutrition-product-nutrient (example, Codes that identify nutrients that could be parts of nutrition products.); (xsd)item:Substance*>?
[]< The amount of nutrient expressed in one or more units: X per pack / per serving / per dose.; (xsd)amount:Ratio>*🔗 Measurements and simple assertions made about a patient, device or other subject. Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as laboratory reports, etc.Observation(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< A unique identifier assigned to this observation.; (xsd)identifier:Identifier>*
< The reference to a FHIR ObservationDefinition resource that provides the definition that is adhered to in whole or in part by this Observation instance. ObservationDefinition can be referenced by its canonical url using instantiatesCanonical, or by a name or an identifier using the appropriate sub-elements of instantiatesReference.; (xsd)instantiates:ObservationDefinition*>?
[]< A plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed.; (xsd)basedOn:(<CarePlan>
|<DeviceRequest>
|<ImmunizationRecommendation>
|<MedicationRequest>
|<NutritionOrder>
|<ServiceRequest>)>*
[]< Identifies the observation(s) that triggered the performance of this observation.; (xsd)triggeredBy:Observation.triggeredBy>*
[]< A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure. To link an Observation to an Encounter use `encounter`. See the [Notes](observation.html#obsgrouping) below for guidance on referencing another Observation.; (xsd)partOf:(<GenomicStudy>
|<ImagingStudy>
|<Immunization>
|<MedicationAdministration>
|<MedicationDispense>
|<MedicationStatement>
|<Procedure>)>*
< The status of the result value. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. Binding: observation-status (required, Codes providing the status of an observation.); (xsd)status:code>
[]< A code that classifies the general type of observation being made. In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set. Binding: observation-category (preferred, Codes for high level observation categories.); (xsd)category:CodeableConcept>*
< Describes what was observed. Sometimes this is called the observation "name". *All* code-value and, if present, component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. Binding: observation-codes (example, Codes identifying names of simple observations.); (xsd)code:CodeableConcept>
< The patient, or group of patients, location, device, organization, procedure or practitioner this observation is about and into whose or what record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the `focus` element or the `code` itself specifies the actual focus of the observation. One would expect this element to be a cardinality of 1..1. The only circumstance in which the subject can be missing is when the observation is made by a device that does not know the patient. In this case, the observation SHALL be matched to a patient through some context/channel matching technique, and at this point, the observation should be updated. The subject of an Observation may in some cases be a procedure. This supports the regulatory inspection use case where observations are captured during inspections of a procedure that is being performed (independent of any particular patient or whether patient related at all).; (xsd)subject:(<BiologicallyDerivedProduct>
|<Device>
|<Group>
|<Location>
|<Medication>
|<NutritionProduct>
|<Organization>
|<Patient>
|<Practitioner>
|<Procedure>
|<Substance>)>?
[]< The actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also be an existing condition, an intervention, the subject's diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child's tracheostomy tube. In this example, the child is the patient of record and the mother is the focus. Typically, an observation is made about the subject - a patient, or group of patients, location, or device - and the distinction between the subject and what is directly measured for an observation is specified in the observation code itself ( e.g., "Blood Glucose") and does not need to be represented separately using this element. Use `specimen` if a reference to a specimen is required. If a code is required instead of a resource use either `bodysite` for bodysites or the standard extension [http://hl7.org/fhir/StructureDefinition/observation-focusCode](http://hl7.org/fhir/extensions/StructureDefinition-observation-focusCode.html).; (xsd)focus:Resource*>*
< The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made. This will typically be the encounter the event occurred within, but some events may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission laboratory tests).; (xsd)encounter:Encounter*>?
< The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the "physiologically relevant time". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself. At least a date should be present unless this observation is a historical report. For recording imprecise or "fuzzy" times (For example, a blood glucose measurement taken "after breakfast") use the [Timing](datatypes.html#timing) datatype which allow the measurement to be tied to regular life events.; (xsd)effective:(<dateTime>
|<instant>
|<Period>
|<Timing>)>?
< The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified. For Observations that don't require review and verification, it may be the same as the [`lastUpdated` ](resource-definitions.html#Meta.lastUpdated) time of the resource itself. For Observations that do require review and verification for certain updates, it might not be the same as the `lastUpdated` time of the resource itself due to a non-clinically significant update that doesn't require the new version to be reviewed and verified again.; (xsd)issued:instant>?
[]< Who was responsible for asserting the observed value as "true".; (xsd)performer:(<CareTeam>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>*
(<valueAttachment:Attachment>
|<valueBoolean:boolean>
|<valueCodeableConcept:CodeableConcept>
|<valueDateTime:dateTime>
|<valueInteger:integer>
|<valueMolecularSequence:MolecularSequence>
|<valuePeriod:Period>
|<valueQuantity:Quantity>
|<valueRange:Range>
|<valueRatio:Ratio>
|<valueSampledData:SampledData>
|<valueString:string>
|<valueTime:time>)?
< Provides a reason why the expected value in the element Observation.value[x] is missing. Null or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be "detected", "not detected", "inconclusive", or "specimen unsatisfactory".
The alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code "error" could be used when the measurement was not completed. Note that an observation may only be reported if there are values to report. For example differential cell counts values may be reported only when > 0. Because of these options, use-case agreements are required to interpret general observations for null or exceptional values. Binding: data-absent-reason (extensible, Codes specifying why the result (`Observation.value[x]`) is missing.); (xsd)dataAbsentReason:CodeableConcept>?
[]< A categorical assessment of an observation value. For example, high, low, normal. Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Binding: observation-interpretation (extensible, Codes identifying interpretations of observations.); (xsd)interpretation:CodeableConcept>*
[]< Comments about the observation or the results. May include general statements about the observation, or statements about significant, unexpected or unreliable results values, or information about its source when relevant to its interpretation.; (xsd)note:Annotation>*
< Indicates the site on the subject's body where the observation was made (i.e. the target site). Only used if not implicit in code found in Observation.code. In many systems, this may be represented as a related observation instead of an inline component. Binding: body-site (example, SNOMED CT Body site concepts); (xsd)bodySite:CodeableConcept>?
< Indicates the body structure on the subject's body where the observation was made (i.e. the target site). Only used if not implicit in code found in Observation.code or bodySite is used. In many systems, this may be represented as a related observation instead of an inline component.; (xsd)bodyStructure:BodyStructure*>?
< Indicates the mechanism used to perform the observation. Only used if not implicit in code for Observation.code. Binding: observation-methods (example, Methods for simple observations.); (xsd)method:CodeableConcept>?
< The specimen that was used when this observation was made. Should only be used if not implicit in code found in `Observation.code`. Observations are not made on specimens themselves; they are made on a subject, but in many cases by the means of a specimen. Note that although specimens are often involved, they are not always tracked and reported explicitly. Also note that observation resources may be used in contexts that track the specimen explicitly (e.g. Diagnostic Report).; (xsd)specimen:(<Group>
|<Specimen>)>?
< A reference to the device that generates the measurements or the device settings for the device. Note that this is not meant to represent a device involved in the transmission of the result, e.g., a gateway. Such devices may be documented using the Provenance resource where relevant.; (xsd)device:(<Device>
|<DeviceMetric>)>?
[]< Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an "OR". In other words, to represent two distinct target populations, two `referenceRange` elements would be used. Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.; (xsd)referenceRange:Observation.referenceRange>*
[]< This observation is a group observation (e.g. a battery, a panel of tests, a set of vital sign measurements) that includes the target as a member of the group. When using this element, an observation will typically have either a value or a set of related resources, although both may be present in some cases. For a discussion on the ways Observations can assembled in groups together, see [Notes](observation.html#obsgrouping) below. Note that a system may calculate results from [QuestionnaireResponse](questionnaireresponse.html) into a final score and represent the score as an Observation.; (xsd)hasMember:(<MolecularSequence>
|<Observation>
|<QuestionnaireResponse>)>*
[]< The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image. All the reference choices that are listed in this element can represent clinical observations and other measurements that may be the source for a derived value. The most common reference will be another Observation. For a discussion on the ways Observations can assembled in groups together, see [Notes](observation.html#obsgrouping) below.; (xsd)derivedFrom:(<DocumentReference>
|<GenomicStudy>
|<ImagingSelection>
|<ImagingStudy>
|<MolecularSequence>
|<Observation>
|<QuestionnaireResponse>)>*
[]< Some observations have multiple component observations. These component observations are expressed as separate code value pairs that share the same attributes. Examples include systolic and diastolic component observations for blood pressure measurement and multiple component observations for genetics observations. For a discussion on the ways Observations can be assembled in groups together see [Notes](observation.html#notes) below.; (xsd)component:Observation.component>*🔗 Some observations have multiple component observations. These component observations are expressed as separate code value pairs that share the same attributes. Examples include systolic and diastolic component observations for blood pressure measurement and multiple component observations for genetics observations. For a discussion on the ways Observations can be assembled in groups together see [Notes](observation.html#notes) below.Observation.component(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Describes what was observed. Sometimes this is called the observation "code". *All* code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. Binding: observation-codes (example, Codes identifying names of simple observations.); (xsd)code:CodeableConcept>
(<valueAttachment:Attachment>
|<valueBoolean:boolean>
|<valueCodeableConcept:CodeableConcept>
|<valueDateTime:dateTime>
|<valueInteger:integer>
|<valueMolecularSequence:MolecularSequence>
|<valuePeriod:Period>
|<valueQuantity:Quantity>
|<valueRange:Range>
|<valueRatio:Ratio>
|<valueSampledData:SampledData>
|<valueString:string>
|<valueTime:time>)?
< Provides a reason why the expected value in the element Observation.component.value[x] is missing. "Null" or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be "detected", "not detected", "inconclusive", or "test not done".
The alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code "error" could be used when the measurement was not completed. Because of these options, use-case agreements are required to interpret general observations for exceptional values. Binding: data-absent-reason (extensible, Codes specifying why the result (`Observation.value[x]`) is missing.); (xsd)dataAbsentReason:CodeableConcept>?
[]< A categorical assessment of an observation value. For example, high, low, normal. Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Binding: observation-interpretation (extensible, Codes identifying interpretations of observations.); (xsd)interpretation:CodeableConcept>*
[]< Guidance on how to interpret the value by comparison to a normal or recommended range. Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.; (xsd)referenceRange:Observation.referenceRange>*🔗 Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an "OR". In other words, to represent two distinct target populations, two `referenceRange` elements would be used. Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.Observation.referenceRange(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The value of the low bound of the reference range. The low bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the low bound is omitted, it is assumed to be meaningless (e.g. reference range is <=2.3).; (xsd)low:SimpleQuantity>?
< The value of the high bound of the reference range. The high bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the high bound is omitted, it is assumed to be meaningless (e.g. reference range is >= 2.3).; (xsd)high:SimpleQuantity>?
< The value of the normal value of the reference range. Binding: observation-referencerange-normalvalue (extensible, Codes identifying the normal value of the observation.); (xsd)normalValue:CodeableConcept>?
< Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range. This SHOULD be populated if there is more than one range. If this element is not present then the normal range is assumed. Binding: referencerange-meaning (preferred, Code for the meaning of a reference range.); (xsd)type:CodeableConcept>?
[]< Codes to indicate the target population this reference range applies to. For example, a reference range may be based on the normal population or a particular sex or race. Multiple `appliesTo` are interpreted as an "AND" of the target populations. For example, to represent a target population of African American females, both a code of female and a code for African American would be used. This SHOULD be populated if there is more than one range. If this element is not present then the normal population is assumed. Binding: referencerange-appliesto (example, Codes identifying the population the reference range applies to.); (xsd)appliesTo:CodeableConcept>*
< The age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so.; (xsd)age:Range>?
< Text based reference range in an observation which may be used when a quantitative range is not appropriate for an observation. An example would be a reference value of "Negative" or a list or table of "normals".; (xsd)text:markdown>?🔗 Identifies the observation(s) that triggered the performance of this observation.Observation.triggeredBy(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Reference to the triggering observation.; (xsd)observation:Observation*>
< The type of trigger.
Reflex | Repeat | Re-run. Binding: observation-triggeredbytype (required, The type of TriggeredBy Observation.); (xsd)type:code>
< Provides the reason why this observation was performed as a result of the observation(s) referenced.; (xsd)reason:string>?🔗 Set of definitional characteristics for a kind of observation or measurement produced or consumed by an orderable health care service. An instance of this resource informs the consumer of a health-related service (such as a lab diagnostic test or panel) about how the observations used or produced by this service will look like.ObservationDefinition(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< An absolute URL that is used to identify this ObservationDefinition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this ObservationDefinition is (or will be) published. The URL SHOULD include the major version of the ObservationDefinition. For more information see Technical and Business Versions. Can be a urn:uuid: or a urn:oid:, but real http: addresses are preferred. This is the URI that will be used when making canonical references to this resource.; (xsd)url:uri>?
< Business identifiers assigned to this ObservationDefinition. by the performer and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server. This is a business identifier, not a resource identifier. It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types.; (xsd)identifier:Identifier>?
< The identifier that is used to identify this version of the ObservationDefinition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the ObservationDefinition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions are orderable. There may be multiple different instances of an observationDefinition that have the same identifier but different versions.; (xsd)version:string>?
< Indicates the mechanism used to compare versions to determine which is more current. If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined. Binding: version-algorithm (extensible, ); (xsd)versionAlgorithm:(<Coding>
|<string>)>?
< A natural language name identifying the ObservationDefinition. This name should be usable as an identifier for the module by machine processing applications such as code generation. The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.; (xsd)name:string>?
< A short, descriptive, user-friendly title for the ObservationDefinition.; (xsd)title:string>?
< The current state of the ObservationDefinition. A nominal state-transition diagram can be found in the [Definition pattern](definition.html#statemachine) documentation
Unknown does not represent "other" - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization). Binding: publication-status (required, Codes identifying the state of an ObservationDefinition.); (xsd)status:code>
< A flag to indicate that this ObservationDefinition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage. Allows filtering of ObservationDefinition that are appropriate for use vs. not.; (xsd)experimental:boolean>?
< The date (and optionally time) when the ObservationDefinition was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the ObservationDefinition changes. The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the ObservationDefinition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)date:dateTime>?
< Helps establish the "authority/credibility" of the ObservationDefinition. May also allow for contact.; (xsd)publisher:string>?
[]< Contact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)contact:ContactDetail>*
< A free text natural language description of the ObservationDefinition from the consumer's perspective. This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the module as conveyed in the text field of the resource itself. This item SHOULD be populated unless the information is available from context.; (xsd)description:markdown>?
[]< The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate ObservationDefinition instances. When multiple usageContexts are specified, there is no expectation for whether all or any of the contexts apply.; (xsd)useContext:UsageContext>*
[]< A jurisdiction in which the ObservationDefinition is intended to be used. It may be possible for the ObservationDefinition to be used in jurisdictions other than those for which it was originally designed or intended.
DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.) Binding: jurisdiction (extensible, Codes for country, country subdivision and region for indicating where a resource is intended to be used.); (xsd)jurisdiction:CodeableConcept>*
< Explains why this ObservationDefinition is needed and why it has been designed as it has. This element does not describe the usage of the ObservationDefinition. Rather it is for traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this ObservationDefinition.; (xsd)purpose:markdown>?
< Copyright statement relating to the ObservationDefinition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the ObservationDefinition.; (xsd)copyright:markdown>?
< A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved'). The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.; (xsd)copyrightLabel:string>?
< The date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usage. The date may be more recent than the approval date because of minor changes / editorial corrections.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)approvalDate:date>?
< The date on which the asset content was last reviewed. Review happens periodically after that, but doesn't change the original approval date. If specified, this is usually after the approval date.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)lastReviewDate:date>?
< The period during which the ObservationDefinition content was or is planned to be effective. The effective period for an ObservationDefinition determines when the content is applicable for usage and is independent of publication and review dates. For example, an observation definition intended to be used for the year 2021 might be published in 2020.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)effectivePeriod:Period>?
[]< The canonical URL pointing to another FHIR-defined ObservationDefinition that is adhered to in whole or in part by this definition.; (xsd)derivedFromCanonical:ObservationDefinition*>*
[]< The URL pointing to an externally-defined observation definition, guideline or other definition that is adhered to in whole or in part by this definition.; (xsd)derivedFromUri:uri>*
[]< A code that describes the intended kind of subject of Observation instances conforming to this ObservationDefinition. Examples: person, animal, device, air, surface ….; (xsd)subject:CodeableConcept>*
< The type of individual/organization/device that is expected to act upon instances of this definition.; (xsd)performerType:CodeableConcept>?
[]< A code that classifies the general type of observation. This element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used for one instance of ObservationDefinition. The level of granularity is defined by the category concepts in the value set. Binding: observation-category (example, Codes for high level observation categories.); (xsd)category:CodeableConcept>*
< Describes what will be observed. Sometimes this is called the observation "name". Binding: observation-codes (example, Codes identifying names of simple observations.); (xsd)code:CodeableConcept>
[]< The data types allowed for the value element of the instance observations conforming to this ObservationDefinition. Binding: permitted-data-type (required, Permitted data type for observation value.); (xsd)permittedDataType:code>*
< Multiple results allowed for observations conforming to this ObservationDefinition. An example of observation allowing multiple results is "bacteria identified by culture". Conversely, the measurement of a potassium level allows a single result.; (xsd)multipleResultsAllowed:boolean>?
< The site on the subject's body where the observation is to be made. Only used if the defined observation is to be made directly on a body part and if this body part is not implied by code found in ObservationDefinition.code. Not used for in vitro diagnostic observations.
Example: 14975008 |Forearm structure|. Binding: body-site (example, SNOMED CT body structures.); (xsd)bodySite:CodeableConcept>?
< The method or technique used to perform the observation. Only used if not implicit in observation code
Example: 702659008 |Automated count technique|. Binding: observation-methods (example, Methods for simple observations.); (xsd)method:CodeableConcept>?
[]< The kind of specimen that this type of observation is produced on. Only used for in vitro observations. When multiple occurrences of specimen are present, they are to be combined with a logical AND: all specified specimens are needed for the observation.; (xsd)specimen:SpecimenDefinition*>*
[]< The measurement model of device or actual device used to produce observations of this type. When multiple occurrences of device are present, they are to be combined with a logical OR: at least one of the specified devices is used to produce the observation.; (xsd)device:(<Device>
|<DeviceDefinition>)>*
< The preferred name to be used when reporting the results of observations conforming to this ObservationDefinition.; (xsd)preferredReportName:string>?
[]< Units allowed for the valueQuantity element in the instance observations conforming to this ObservationDefinition. Binding: ucum-units (preferred, Codes identifying units of measure.); (xsd)permittedUnit:Coding>*
[]< A set of qualified values associated with a context and a set of conditions - provides a range for quantitative and ordinal observations and a collection of value sets for qualitative observations.; (xsd)qualifiedValue:ObservationDefinition.qualifiedValue>*
[]< This ObservationDefinition defines a group observation (e.g. a battery, a panel of tests, a set of vital sign measurements) that includes the target as a member of the group.; (xsd)hasMember:(<ObservationDefinition>
|<Questionnaire>)>*
[]< Some observations have multiple component observations, expressed as separate code value pairs.; (xsd)component:ObservationDefinition.component>*🔗 Some observations have multiple component observations, expressed as separate code value pairs.ObservationDefinition.component(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Describes what will be observed. Binding: observation-codes (example, Codes identifying names of simple observations.); (xsd)code:CodeableConcept>
[]< The data types allowed for the value element of the instance of this component observations. Binding: permitted-data-type (required, Permitted data type for observation value.); (xsd)permittedDataType:code>*
[]< Units allowed for the valueQuantity element in the instance observations conforming to this ObservationDefinition. Binding: ucum-units (preferred, Codes identifying units of measure.); (xsd)permittedUnit:Coding>*
[]< A set of qualified values associated with a context and a set of conditions - provides a range for quantitative and ordinal observations and a collection of value sets for qualitative observations.; (xsd)qualifiedValue:ObservationDefinition.qualifiedValue>*🔗 A set of qualified values associated with a context and a set of conditions - provides a range for quantitative and ordinal observations and a collection of value sets for qualitative observations.ObservationDefinition.qualifiedValue(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A concept defining the context for this set of qualified values. Binding: referencerange-meaning (extensible, ); (xsd)context:CodeableConcept>?
[]< The target population this set of qualified values applies to. If this element is not present then the global population is assumed. Binding: referencerange-appliesto (example, ); (xsd)appliesTo:CodeableConcept>*
< The gender this set of qualified values applies to. Binding: administrative-gender (required, ); (xsd)gender:code>?
< The age range this set of qualified values applies to. Some analytes vary greatly over age.; (xsd)age:Range>?
< The gestational age this set of qualified values applies to.; (xsd)gestationalAge:Range>?
< Text based condition for which the the set of qualified values is valid.; (xsd)condition:string>?
< The category of range of values for continuous or ordinal observations that match the criteria of this set of qualified values. Binding: observation-range-category (required, ); (xsd)rangeCategory:code>?
< The range of values defined for continuous or ordinal observations that match the criteria of this set of qualified values.; (xsd)range:Range>?
< The set of valid coded results for qualitative observations that match the criteria of this set of qualified values.; (xsd)validCodedValueSet:ValueSet*>?
< The set of normal coded results for qualitative observations that match the criteria of this set of qualified values.; (xsd)normalCodedValueSet:ValueSet*>?
< The set of abnormal coded results for qualitative observations that match the criteria of this set of qualified values.; (xsd)abnormalCodedValueSet:ValueSet*>?
< The set of critical coded results for qualitative observations that match the criteria of this set of qualified values.; (xsd)criticalCodedValueSet:ValueSet*>?🔗 An OID represented as a URI RFC 3001. See also ISO/IEC 8824:1990 €oid(xsd)(doc)=
<#base:uri>
< unique id for the element within a resource (for internal references); (xsd)id:string>?
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< Primitive value for oid; (xsd)value:string>?🔗 A formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).OperationDefinition(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< An absolute URI that is used to identify this operation definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this operation definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the operation definition is stored on different servers. Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.
The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions).
In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.; (xsd)url:uri>?
[]< A formal identifier that is used to identify this implementation guide when it is represented in other formats, or referenced in a specification, model, design or an instance.; (xsd)identifier:Identifier>*
< The identifier that is used to identify this version of the operation definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the operation definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. There may be different operation definitions that have the same url but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the operation definition with the format. The version SHOULD NOT contain a '#' - see [Business Version](resource.html#bv-format).; (xsd)version:string>?
< Indicates the mechanism used to compare versions to determine which is more current. If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined. Binding: version-algorithm (extensible, ); (xsd)versionAlgorithm:(<Coding>
|<string>)>?
< A natural language name identifying the operation definition. This name should be usable as an identifier for the module by machine processing applications such as code generation. The name is not expected to be globally unique. The name should be a simple alphanumeric type no-whitespace name to ensure that it is machine-processing friendly.; (xsd)name:string>
< A short, descriptive, user-friendly title for the operation definition. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.; (xsd)title:string>?
< The current state of this operation definition. A nominal state-transition diagram can be found in the] documentation
Unknown does not represent 'other' - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is. Binding: publication-status (required, The lifecycle status of an artifact.); (xsd)status:code>
< Whether this is an operation or a named query. Named queries are invoked differently, and have different capabilities. Binding: operation-kind (required, Whether an operation is a normal operation or a query.); (xsd)kind:code>
< A Boolean value to indicate that this operation definition is authored for testing purposes (or education/evaluation/marketing) and is not intended for genuine usage. Allows filtering of operation definitions that are appropriate for use versus not.; (xsd)experimental:boolean>?
< The date (and optionally time) when the operation definition was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the operation definition changes. The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the operation definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)date:dateTime>?
< The name of the organization or individual responsible for the release and ongoing maintenance of the operation definition. Usually an organization but may be an individual. The publisher (or steward) of the operation definition is the organization or individual primarily responsible for the maintenance and upkeep of the operation definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the operation definition. This item SHOULD be populated unless the information is available from context.; (xsd)publisher:string>?
[]< Contact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)contact:ContactDetail>*
< A free text natural language description of the operation definition from a consumer's perspective. This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the operation definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the operation definition is presumed to be the predominant language in the place the operation definition was created).; (xsd)description:markdown>?
[]< The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate operation definition. When multiple useContexts are specified, there is no expectation that all or even any of the contexts apply.; (xsd)useContext:UsageContext>*
[]< A legal or geographic region in which the operation definition is intended to be used. It may be possible for the operation definition to be used in jurisdictions other than those for which it was originally designed or intended.
DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.) Binding: jurisdiction (extensible, Countries and regions within which this artifact is targeted for use.); (xsd)jurisdiction:CodeableConcept>*
< Explanation of why this operation definition is needed and why it has been designed as it has. This element does not describe the usage of the operation definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this operation definition.; (xsd)purpose:markdown>?
< A copyright statement relating to the operation definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the operation definition.; (xsd)copyright:markdown>?
< A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved'). The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.; (xsd)copyrightLabel:string>?
< Whether the operation affects state. Side effects such as producing audit trail entries do not count as 'affecting state'. What http methods can be used for the operation depends on the .affectsState value and whether the input parameters are primitive or complex:
1. Servers SHALL support POST method for all operations.
2. Servers SHALL support the GET method when the operation has affectsState = false and all required parameters for the operation are primitive.; (xsd)affectsState:boolean>?
< The label that is recommended to be used in the URL for this operation. In some cases, servers may need to use a different CapabilityStatement operation.name to differentiate between multiple SearchParameters that happen to have the same code. For maximum compatibility, use only lowercase ASCII characters. Note that HL7 will never define multiple operations with the same code. See [Naming Rules & Guidelines](https://confluence.hl7.org/display/FHIR/Guide+to+Designing+Resources#GuidetoDesigningResources-NamingRules&Guidelines) for the internal HL7 rules around codes, which are useful additional advice for all implementers; (xsd)code>
< Additional information about how to use this operation or named query.; (xsd)comment:markdown>?
< Indicates that this operation definition is a constraining profile on the base. A constrained profile can make optional parameters required or not used, introduce new parameters (required or optional), and clarify documentation.; (xsd)base:OperationDefinition*>?
[]< The types on which this operation can be executed. If the type is an abstract resource ("Resource" or "DomainResource") then the operation can be invoked on any concrete specialization. Binding: version-independent-all-resource-types (required, A type of resource, or a Reference (from all versions)); (xsd)resource:code>*
< Indicates whether this operation or named query can be invoked at the system level (e.g. without needing to choose a resource type for the context).; (xsd)system:boolean>
< Indicates whether this operation or named query can be invoked at the resource type level for any given resource type level (e.g. without needing to choose a specific resource id for the context).; (xsd)type:boolean>
< Indicates whether this operation can be invoked on a particular instance of one of the given types.; (xsd)instance:boolean>
< Additional validation information for the in parameters - a single profile that covers all the parameters. The profile is a constraint on the parameters resource as a whole. If present the profile shall not conflict with what is specified in the parameters in the operation definition (max/min etc.), though it may provide additional constraints. The constraints expressed in the profile apply whether the operation is invoked by a POST wih parameters or not.; (xsd)inputProfile:StructureDefinition*>?
< Additional validation information for the out parameters - a single profile that covers all the parameters. The profile is a constraint on the parameters resource. If present the profile shall not conflict with what is specified in the parameters in the operation definition (max/min etc.), though it may provide additional constraints. The constraints expressed in the profile apply whether the operation is invoked by a POST wih parameters or not.; (xsd)outputProfile:StructureDefinition*>?
[]< The parameters for the operation/query. Query Definitions only have one output parameter, named "result". This might not be described, but can be to allow a profile to be defined.; (xsd)parameter:OperationDefinition.parameter>*
[]< Defines an appropriate combination of parameters to use when invoking this operation, to help code generators when generating overloaded parameter sets for this operation. The combinations are suggestions as to which sets of parameters to use together, but the combinations are not intended to be authoritative.; (xsd)overload:OperationDefinition.overload>*🔗 Defines an appropriate combination of parameters to use when invoking this operation, to help code generators when generating overloaded parameter sets for this operation. The combinations are suggestions as to which sets of parameters to use together, but the combinations are not intended to be authoritative.OperationDefinition.overload(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< Name of parameter to include in overload.; (xsd)parameterName:string>*
< Comments to go on overload.; (xsd)comment:string>?🔗 The parameters for the operation/query. Query Definitions only have one output parameter, named "result". This might not be described, but can be to allow a profile to be defined.OperationDefinition.parameter(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The name of used to identify the parameter. This name must be a token (start with a letter in a..z, and only contain letters, numerals, and underscore. Note that for search parameters (type = string, with a search type), the name may be altered by the search modifiers.; (xsd)name:code>
< Whether this is an input or an output parameter. If a parameter name is used for both an input and an output parameter, the parameter should be defined twice. Binding: operation-parameter-use (required, Whether an operation parameter is an input or an output parameter.); (xsd)use:code>
[]< If present, indicates that the parameter applies when the operation is being invoked at the specified level. Binding: operation-parameter-scope (required, ); (xsd)scope:code>*
< The minimum number of times this parameter SHALL appear in the request or response.; (xsd)min:integer>
< The maximum number of times this element is permitted to appear in the request or response.; (xsd)max:string>
< Describes the meaning or use of this parameter.; (xsd)documentation:markdown>?
< The type for this parameter. if there is no stated parameter, then the parameter is a multi-part parameter type and must have at least one part defined. Binding: fhir-types (required, A list of all the types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.); (xsd)type:code>?
[]< Support for polymorphic types. If the parameter type is abstract, this element lists allowed sub-types for the parameter. In previous versions of FHIR, there was an extension for this: http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type Binding: fhir-types (required, A list of all the types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.); (xsd)allowedType:code>*
[]< 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 parameter 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. Often, these profiles are the base definitions from the spec (e.g. http://hl7.org/fhir/StructureDefinition/Patient).; (xsd)targetProfile:StructureDefinition*>*
< How the parameter is understood if/when it used as search parameter. This is only used if the parameter is a string. Parameters that are search parameter usually - but not always - are also defined for use with general searches, and function in the operation to filter the set of resources in scope for the operation just like the do when searching. The searchType describes how the server processes the value. For an example, see the [Evaluate Measure Operation](measure-operation-evaluate-measure.html) Binding: search-param-type (required, Data types allowed to be used for search parameters.); (xsd)searchType:code>?
< Binds to a value set if this parameter is coded (code, Coding, CodeableConcept).; (xsd)binding:OperationDefinition.parameter.binding>?
[]< Identifies other resource parameters within the operation invocation that are expected to resolve to this resource. Resolution applies if the referenced parameter exists.; (xsd)referencedFrom:OperationDefinition.parameter.referencedFrom>*
[]< The parts of a nested Parameter. Query Definitions only have one output parameter, named "result". This might not be described, but can be to allow a profile to be defined.; (xsd)part:OperationDefinition.parameter>*🔗 Binds to a value set if this parameter is coded (code, Coding, CodeableConcept).OperationDefinition.parameter.binding(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< 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). Binding: binding-strength (required, Indication of the degree of conformance expectations associated with a binding.); (xsd)strength:code>
< Points to the value set or external definition (e.g. implicit value set) that identifies the set of codes to be used. For value sets with a referenceResource, the display can contain the value set description. The reference may be version-specific or not.; (xsd)valueSet:ValueSet*>🔗 Identifies other resource parameters within the operation invocation that are expected to resolve to this resource. Resolution applies if the referenced parameter exists.OperationDefinition.parameter.referencedFrom(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The name of the parameter or dot-separated path of parameter names pointing to the resource parameter that is expected to contain a reference to this resource.; (xsd)source:string>
< The id of the element in the referencing resource that is expected to resolve to this resource.; (xsd)sourceId:string>?🔗 A collection of error, warning, or information messages that result from a system action. Can result from the failure of a REST call or be part of the response message returned from a request message.OperationOutcome(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< An error, warning, or information message that results from a system action.; (xsd)issue:OperationOutcome.issue>+🔗 An error, warning, or information message that results from a system action.OperationOutcome.issue(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Indicates whether the issue indicates a variation from successful processing. Binding: issue-severity (required, How the issue affects the success of the action.); (xsd)severity:code>
< Describes the type of the issue. The system that creates an OperationOutcome SHALL choose the most applicable code from the IssueType value set, and may additional provide its own code for the error in the details element. Code values should align with the severity. For example, a code of ```forbidden``` generally wouldn't make sense with a severity of ```information``` or ```warning```. Similarly, a code of ```informational``` would generally not make sense with a severity of ```fatal``` or ```error```. However, there are no strict rules about what severities must be used with which codes. For example, ```code-invalid``` might be a ```warning``` or ```error```, depending on the context Binding: issue-type (required, A code that describes the type of issue.); (xsd)code>
< Additional details about the error. This may be a text description of the error or a system code that identifies the error. A human readable description of the error issue SHOULD be placed in details.text. Binding: operation-outcome (example, A code that provides details as the exact issue.); (xsd)details:CodeableConcept>?
< Additional diagnostic information about the issue. This may be a description of how a value is erroneous, a stack dump to help trace the issue or other troubleshooting information.; (xsd)diagnostics:string>?
[]< This element is deprecated because it is XML specific. It is replaced by issue.expression, which is format independent, and simpler to parse.
For resource issues, this will be a simple XPath limited to element names, repetition indicators and the default child accessor that identifies one of the elements in the resource that caused this issue to be raised. For HTTP errors, will be "http." + the parameter name. The root of the XPath is the resource or bundle that generated OperationOutcome. Each XPath SHALL resolve to a single node. This element is deprecated, and is being replaced by expression.; (xsd)location:string>*
[]< A [simple subset of FHIRPath](fhirpath.html#simple) limited to element names, repetition indicators and the default child accessor that identifies one of the elements in the resource that caused this issue to be raised. The root of the FHIRPath is the resource or bundle that generated OperationOutcome. Each FHIRPath SHALL resolve to a single node.; (xsd)expression:string>*🔗 A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc.Organization(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< Identifier for the organization that is used to identify the organization across multiple disparate systems.; (xsd)identifier:Identifier>*
< Whether the organization's record is still in active use. This active flag is not intended to be used to mark an organization as temporarily closed or under construction. Instead the Location(s) within the Organization should have the suspended status. If further details of the reason for the suspension are required, then an extension on this element should be used.
This element is labeled as a modifier because it may be used to mark that the resource was created in error.; (xsd)active:boolean>?
[]< The kind(s) of organization that this is. Organizations can be corporations, wards, sections, clinical teams, government departments, etc. Note that code is generally a classifier of the type of organization; in many applications, codes are used to identity a particular organization (say, ward) as opposed to another of the same type - these are identifiers, not codes
When considering if multiple types are appropriate, you should evaluate if child organizations would be a more appropriate use of the concept, as different types likely are in different sub-areas of the organization. This is most likely to be used where type values have orthogonal values, such as a religious, academic and medical center.
We expect that some jurisdictions will profile this optionality to be a single cardinality. Binding: organization-type (example, Used to categorize the organization.); (xsd)type:CodeableConcept>*
< A name associated with the organization. If the name of an organization changes, consider putting the old name in the alias column so that it can still be located through searches.; (xsd)name:string>?
[]< A list of alternate names that the organization is known as, or was known as in the past. There are no dates associated with the alias/historic names, as this is not intended to track when names were used, but to assist in searching so that older names can still result in identifying the organization.; (xsd)alias:string>*
< Description of the organization, which helps provide additional general context on the organization to ensure that the correct organization is selected.; (xsd)description:markdown>?
[]< The contact details of communication devices available relevant to the specific Organization. This can include addresses, phone numbers, fax numbers, mobile numbers, email addresses and web sites. The address/telecom use code 'home' are not to be used. Note that these contacts are not the contact details of people who provide the service (that would be through PractitionerRole), these are official contacts for the Organization itself for specific purposes. E.g. Mailing Addresses, Billing Addresses, Contact numbers for Booking or Billing Enquiries, general web address, web address for online bookings etc.; (xsd)contact:ExtendedContactDetail>*
< The organization of which this organization forms a part.; (xsd)partOf:Organization*>?
[]< Technical endpoints providing access to services operated for the organization.; (xsd)endpoint:Endpoint*>*
[]< The official certifications, accreditations, training, designations and licenses that authorize and/or otherwise endorse the provision of care by the organization.
For example, an approval to provide a type of services issued by a certifying body (such as the US Joint Commission) to an organization.; (xsd)qualification:Organization.qualification>*🔗 The official certifications, accreditations, training, designations and licenses that authorize and/or otherwise endorse the provision of care by the organization.
For example, an approval to provide a type of services issued by a certifying body (such as the US Joint Commission) to an organization.Organization.qualification(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< An identifier allocated to this qualification for this organization.; (xsd)identifier:Identifier>*
< Coded representation of the qualification. Binding: (example, Specific qualification the organization has to provide a service.); (xsd)code:CodeableConcept>
< Period during which the qualification is valid.; (xsd)period:Period>?
< Organization that regulates and issues the qualification.; (xsd)issuer:Organization*>?🔗 Defines an affiliation/association/relationship between 2 distinct organizations, that is not a part-of relationship/sub-division relationship.OrganizationAffiliation(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< Business identifiers that are specific to this role.; (xsd)identifier:Identifier>*
< Whether this organization affiliation record is in active use. If this value is false, you may refer to the period to see when the role was in active use. If there is no period specified, no inference can be made about when it was active.; (xsd)active:boolean>?
< The period during which the participatingOrganization is affiliated with the primary organization.; (xsd)period:Period>?
< Organization where the role is available (primary organization/has members). For example, a Spotless Cleaning Services (participatingOrganization) is a supplier (code) to General Hospital (organization). Similarly, General Hospital (participatingOrganization) is a member (code) of Eastern HIE (organization). If there are two organizations that do not have a directional relationship, there would normally be a third organization that represents the joint partnership, and the two organizations would have a relationship to that joint Organization via two OrganizationAffiliations.; (xsd)organization:Organization*>?
< The Participating Organization provides/performs the role(s) defined by the code to the Primary Organization (e.g. providing services or is a member of). See comments for OrganizationAffiliation.organization above.; (xsd)participatingOrganization:Organization*>?
[]< The network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined). e.g. Commonly used for Health Insurance provider networks.; (xsd)network:Organization*>*
[]< Definition of the role the participatingOrganization plays in the association. Binding: organization-role (example, The role the participating organization providing services to the primary organization.); (xsd)code:CodeableConcept>*
[]< Specific specialty of the participatingOrganization in the context of the role. Binding: c80-practice-codes (preferred, Specific specialty associated with the participating organization.); (xsd)specialty:CodeableConcept>*
[]< The location(s) at which the role occurs.; (xsd)location:Location*>*
[]< Healthcare services provided through the role.; (xsd)healthcareService:HealthcareService*>*
[]< The contact details of communication devices available at the participatingOrganization relevant to this Affiliation.; (xsd)contact:ExtendedContactDetail>*
[]< Technical endpoints providing access to services operated for this role.; (xsd)endpoint:Endpoint*>*🔗 This profile defines how to represent Oxygen Saturation observations in FHIR using a standard LOINC code and UCUM units of measure. Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as laboratory reports, etc.oxygensat(xsd)(doc)=
<#base:vitalsigns>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< A unique identifier assigned to this observation.; (xsd)identifier:Identifier>*
< The reference to a FHIR ObservationDefinition resource that provides the definition that is adhered to in whole or in part by this Observation instance. ObservationDefinition can be referenced by its canonical url using instantiatesCanonical, or by a name or an identifier using the appropriate sub-elements of instantiatesReference.; (xsd)instantiates:ObservationDefinition*>?
[]< A plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed.; (xsd)basedOn:(<CarePlan>
|<DeviceRequest>
|<ImmunizationRecommendation>
|<MedicationRequest>
|<NutritionOrder>
|<ServiceRequest>)>*
[]< Identifies the observation(s) that triggered the performance of this observation.; (xsd)triggeredBy:oxygensat.triggeredBy>*
[]< A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure. To link an Observation to an Encounter use `encounter`. See the [Notes](observation.html#obsgrouping) below for guidance on referencing another Observation.; (xsd)partOf:(<GenomicStudy>
|<ImagingStudy>
|<Immunization>
|<MedicationAdministration>
|<MedicationDispense>
|<MedicationStatement>
|<Procedure>)>*
< The status of the result value. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. Binding: observation-status (required, ); (xsd)status:code>
[]< A code that classifies the general type of observation being made. In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set. Binding: observation-category (preferred, Codes for high level observation categories.); (xsd)category:CodeableConcept>+
< Oxygen Saturation. additional codes that translate or map to this code are allowed. For example a more granular LOINC code or code that is used locally in a system. Binding: observation-vitalsignresult (extensible, This identifies the vital sign result type. Original source C-CDA R1.1 , HITSP Vital Sign Result Type.); (xsd)code:oxygensat.code>
< The patient, or group of patients, location, device, organization, procedure or practitioner this observation is about and into whose or what record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the `focus` element or the `code` itself specifies the actual focus of the observation. One would expect this element to be a cardinality of 1..1. The only circumstance in which the subject can be missing is when the observation is made by a device that does not know the patient. In this case, the observation SHALL be matched to a patient through some context/channel matching technique, and at this point, the observation should be updated. The subject of an Observation may in some cases be a procedure. This supports the regulatory inspection use case where observations are captured during inspections of a procedure that is being performed (independent of any particular patient or whether patient related at all).; (xsd)subject:Patient*>
[]< The actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also be an existing condition, an intervention, the subject's diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child's tracheostomy tube. In this example, the child is the patient of record and the mother is the focus. Typically, an observation is made about the subject - a patient, or group of patients, location, or device - and the distinction between the subject and what is directly measured for an observation is specified in the observation code itself ( e.g., "Blood Glucose") and does not need to be represented separately using this element. Use `specimen` if a reference to a specimen is required. If a code is required instead of a resource use either `bodysite` for bodysites or the standard extension [http://hl7.org/fhir/StructureDefinition/observation-focusCode](http://hl7.org/fhir/extensions/StructureDefinition-observation-focusCode.html).; (xsd)focus:Resource*>*
< The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made. This will typically be the encounter the event occurred within, but some events may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission laboratory tests).; (xsd)encounter:Encounter*>?
< Often just a dateTime for Vital Signs. At least a date should be present unless this observation is a historical report. For recording imprecise or "fuzzy" times (For example, a blood glucose measurement taken "after breakfast") use the [Timing](datatypes.html#timing) datatype which allow the measurement to be tied to regular life events.; (xsd)effective:(<dateTime>
|<Period>)>
< The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified. For Observations that don't require review and verification, it may be the same as the [`lastUpdated` ](resource-definitions.html#Meta.lastUpdated) time of the resource itself. For Observations that do require review and verification for certain updates, it might not be the same as the `lastUpdated` time of the resource itself due to a non-clinically significant update that doesn't require the new version to be reviewed and verified again.; (xsd)issued:instant>?
[]< Who was responsible for asserting the observed value as "true".; (xsd)performer:(<CareTeam>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>*
(<valueAttachment:Attachment>
|<valueBoolean:boolean>
|<valueCodeableConcept:CodeableConcept>
|<valueDateTime:dateTime>
|<valueInteger:integer>
|<valueMolecularSequence:MolecularSequence>
|<valuePeriod:Period>
|<valueQuantity:Quantity>
|<valueRange:Range>
|<valueRatio:Ratio>
|<valueSampledData:SampledData>
|<valueString:string>
|<valueTime:time>)?
< Provides a reason why the expected value in the element Observation.value[x] is missing. Null or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be "detected", "not detected", "inconclusive", or "specimen unsatisfactory".
The alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code "error" could be used when the measurement was not completed. Note that an observation may only be reported if there are values to report. For example differential cell counts values may be reported only when > 0. Because of these options, use-case agreements are required to interpret general observations for null or exceptional values. Binding: data-absent-reason (extensible, Codes specifying why the result (`Observation.value[x]`) is missing.); (xsd)dataAbsentReason:CodeableConcept>?
[]< A categorical assessment of an observation value. For example, high, low, normal. Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Binding: observation-interpretation (extensible, Codes identifying interpretations of observations.); (xsd)interpretation:CodeableConcept>*
[]< Comments about the observation or the results. May include general statements about the observation, or statements about significant, unexpected or unreliable results values, or information about its source when relevant to its interpretation.; (xsd)note:Annotation>*
< Indicates the site on the subject's body where the observation was made (i.e. the target site). Only used if not implicit in code found in Observation.code. In many systems, this may be represented as a related observation instead of an inline component. Binding: body-site (example, SNOMED CT Body site concepts); (xsd)bodySite:CodeableConcept>?
< Indicates the body structure on the subject's body where the observation was made (i.e. the target site). Only used if not implicit in code found in Observation.code or bodySite is used. In many systems, this may be represented as a related observation instead of an inline component.; (xsd)bodyStructure:BodyStructure*>?
< Indicates the mechanism used to perform the observation. Only used if not implicit in code for Observation.code. Binding: observation-methods (example, Methods for simple observations.); (xsd)method:CodeableConcept>?
< The specimen that was used when this observation was made. Should only be used if not implicit in code found in `Observation.code`. Observations are not made on specimens themselves; they are made on a subject, but in many cases by the means of a specimen. Note that although specimens are often involved, they are not always tracked and reported explicitly. Also note that observation resources may be used in contexts that track the specimen explicitly (e.g. Diagnostic Report).; (xsd)specimen:(<Group>
|<Specimen>)>?
< A reference to the device that generates the measurements or the device settings for the device. Note that this is not meant to represent a device involved in the transmission of the result, e.g., a gateway. Such devices may be documented using the Provenance resource where relevant.; (xsd)device:(<Device>
|<DeviceMetric>)>?
[]< Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an "OR". In other words, to represent two distinct target populations, two `referenceRange` elements would be used. Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.; (xsd)referenceRange:oxygensat.referenceRange>*
[]< Used when reporting vital signs panel components. When using this element, an observation will typically have either a value or a set of related resources, although both may be present in some cases. For a discussion on the ways Observations can assembled in groups together, see [Notes](observation.html#obsgrouping) below. Note that a system may calculate results from [QuestionnaireResponse](questionnaireresponse.html) into a final score and represent the score as an Observation.; (xsd)hasMember:(<MolecularSequence>
|<QuestionnaireResponse>
|<vitalsigns>)>*
[]< The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image. All the reference choices that are listed in this element can represent clinical observations and other measurements that may be the source for a derived value. The most common reference will be another Observation. For a discussion on the ways Observations can assembled in groups together, see [Notes](observation.html#obsgrouping) below.; (xsd)derivedFrom:(<DocumentReference>
|<ImagingStudy>
|<MolecularSequence>
|<QuestionnaireResponse>
|<vitalsigns>)>*
[]< Used when reporting systolic and diastolic blood pressure. For a discussion on the ways Observations can be assembled in groups together see [Notes](observation.html#notes) below.; (xsd)component:oxygensat.component>*
< A code that classifies the general type of observation being made. In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set. Binding: observation-category (preferred, Codes for high level observation categories.); (xsd)VSCat:oxygensat.VSCat>
< Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept. - An observation may have:
1. a single value here
1. both a value and a set of related or component values
1. only a set of related or component values.
- If a value is present, the datatype for this element should be determined by the `code`.
- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.
- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.
- The usage of valueReference is restricted to the MolecularSequence resource when used as a definitional resource, not as a patient-specific finding. .
- For additional guidance, see the [Notes section](observation.html#notes) below.; (xsd)valueQuantity:oxygensat.valueQuantity>?🔗 Oxygen Saturation. additional codes that translate or map to this code are allowed. For example a more granular LOINC code or code that is used locally in a system. Binding: observation-vitalsignresult (extensible, This identifies the vital sign result type. Original source C-CDA R1.1 , HITSP Vital Sign Result Type.)oxygensat.code(xsd)(doc)=
<#base:CodeableConcept>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< 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.; (xsd)coding:Coding>*
< 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.; (xsd)text:string>?
< 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.; (xsd)OxygenSatCode:oxygensat.code.OxygenSatCode>🔗 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.oxygensat.code.OxygenSatCode(xsd)(doc)=
<#base:Coding>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< 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 be an absolute reference to some definition that establishes the system clearly and unambiguously. http://loinc.org; (xsd)system:uri>
< 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.; (xsd)version:string>?
< 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). 2708-6; (xsd)code>
< A representation of the meaning of the code in the system, following the rules of the system.; (xsd)display:string>?
< 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.; (xsd)userSelected:boolean>?🔗 Used when reporting systolic and diastolic blood pressure. For a discussion on the ways Observations can be assembled in groups together see [Notes](observation.html#notes) below.oxygensat.component(xsd)(doc)=
<#base:Observation.component>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Describes what was observed. Sometimes this is called the observation "code". *All* code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. Binding: observation-vitalsignresult (extensible, This identifies the vital sign result type. Original source C-CDA R1.1 , HITSP Vital Sign Result Type.); (xsd)code:CodeableConcept>
(<valueAttachment:Attachment>
|<valueBoolean:boolean>
|<valueCodeableConcept:CodeableConcept>
|<valueDateTime:dateTime>
|<valueInteger:integer>
|<valueMolecularSequence:MolecularSequence>
|<valuePeriod:Period>
|<valueQuantity:Quantity>
|<valueRange:Range>
|<valueRatio:Ratio>
|<valueSampledData:SampledData>
|<valueString:string>
|<valueTime:time>)?
< Provides a reason why the expected value in the element Observation.component.value[x] is missing. "Null" or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be "detected", "not detected", "inconclusive", or "test not done".
The alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code "error" could be used when the measurement was not completed. Because of these options, use-case agreements are required to interpret general observations for exceptional values. Binding: data-absent-reason (extensible, Codes specifying why the result (`Observation.value[x]`) is missing.); (xsd)dataAbsentReason:CodeableConcept>?
[]< A categorical assessment of an observation value. For example, high, low, normal. Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Binding: observation-interpretation (extensible, Codes identifying interpretations of observations.); (xsd)interpretation:CodeableConcept>*
[]< Guidance on how to interpret the value by comparison to a normal or recommended range. Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.; (xsd)referenceRange:Observation.referenceRange>*
< Vital Sign Value recorded with UCUM. Used when observation has a set of component observations:
- An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was derived).
- If a value is present, the datatype for this element should be determined by the `code`.
- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.
- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.
- If a value is present, the datatype for this element should be determined by the `code`.
- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.
- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.
- The usage of valueReference is restricted to the MolecularSequence resource when used as a definitional resource, not as a patient-specific finding. .
- For additional guidance, see the [Notes section](observation.html#notes) below. Binding: ucum-vitals-common (required, Commonly encountered UCUM units for recording Vital Signs.); (xsd)valueQuantity:Quantity>?🔗 Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an "OR". In other words, to represent two distinct target populations, two `referenceRange` elements would be used. Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.oxygensat.referenceRange(xsd)(doc)=
<#base:Observation.referenceRange>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The value of the low bound of the reference range. The low bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the low bound is omitted, it is assumed to be meaningless (e.g. reference range is <=2.3).; (xsd)low:SimpleQuantity>?
< The value of the high bound of the reference range. The high bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the high bound is omitted, it is assumed to be meaningless (e.g. reference range is >= 2.3).; (xsd)high:SimpleQuantity>?
< The value of the normal value of the reference range. Binding: observation-referencerange-normalvalue (extensible, Codes identifying the normal value of the observation.); (xsd)normalValue:CodeableConcept>?
< Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range. This SHOULD be populated if there is more than one range. If this element is not present then the normal range is assumed. Binding: referencerange-meaning (preferred, Code for the meaning of a reference range.); (xsd)type:CodeableConcept>?
[]< Codes to indicate the target population this reference range applies to. For example, a reference range may be based on the normal population or a particular sex or race. Multiple `appliesTo` are interpreted as an "AND" of the target populations. For example, to represent a target population of African American females, both a code of female and a code for African American would be used. This SHOULD be populated if there is more than one range. If this element is not present then the normal population is assumed. Binding: referencerange-appliesto (example, Codes identifying the population the reference range applies to.); (xsd)appliesTo:CodeableConcept>*
< The age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so.; (xsd)age:Range>?
< Text based reference range in an observation which may be used when a quantitative range is not appropriate for an observation. An example would be a reference value of "Negative" or a list or table of "normals".; (xsd)text:markdown>?🔗 Identifies the observation(s) that triggered the performance of this observation.oxygensat.triggeredBy(xsd)(doc)=
<#base:Observation.triggeredBy>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Reference to the triggering observation.; (xsd)observation:Observation*>
< The type of trigger.
Reflex | Repeat | Re-run. Binding: observation-triggeredbytype (required, The type of TriggeredBy Observation.); (xsd)type:code>
< Provides the reason why this observation was performed as a result of the observation(s) referenced.; (xsd)reason:string>?🔗 Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept. - An observation may have:
1. a single value here
1. both a value and a set of related or component values
1. only a set of related or component values.
- If a value is present, the datatype for this element should be determined by the `code`.
- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.
- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.
- The usage of valueReference is restricted to the MolecularSequence resource when used as a definitional resource, not as a patient-specific finding. .
- For additional guidance, see the [Notes section](observation.html#notes) below.oxygensat.valueQuantity(xsd)(doc)=
<#base:Quantity>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< 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).; (xsd)value:decimal>
< 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. Binding: quantity-comparator (required, How the Quantity should be understood and represented.); (xsd)comparator:code>?
< A human-readable form of the unit.; (xsd)unit:string>
< The identification of the system that provides the coded form of the unit. http://unitsofmeasure.org; (xsd)system:uri>
< Coded responses from the common UCUM units for vital signs value set. 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. %; (xsd)code>🔗 A code that classifies the general type of observation being made. In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set. Binding: observation-category (preferred, Codes for high level observation categories.)oxygensat.VSCat(xsd)(doc)=
<#base:vitalsigns.VSCat>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< 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.; (xsd)coding:oxygensat.VSCat.coding>+
< 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.; (xsd)text:string>?🔗 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.oxygensat.VSCat.coding(xsd)(doc)=
<#base:vitalsigns.VSCat.coding>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< 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 be an absolute reference to some definition that establishes the system clearly and unambiguously. http://terminology.hl7.org/CodeSystem/observation-category; (xsd)system:uri>
< 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.; (xsd)version:string>?
< 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). vital-signs; (xsd)code>
< A representation of the meaning of the code in the system, following the rules of the system.; (xsd)display:string>?
< 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.; (xsd)userSelected:boolean>?🔗 A medically related item or items, in a container or package.PackagedProductDefinition(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< A unique identifier for this package as whole - not the the content of the package. Unique instance identifiers assigned to a package by manufacturers, regulators, drug catalogue custodians or other organizations.; (xsd)identifier:Identifier>*
< A name for this package. Typically what it would be listed as in a drug formulary or catalogue, inventory etc.; (xsd)name:string>?
< A high level category e.g. medicinal product, raw material, shipping/transport container, etc. Binding: package-type (example, A high level categorisation of a package.); (xsd)type:CodeableConcept>?
[]< The product this package model relates to, not the contents of the package (for which see package.containedItem).; (xsd)packageFor:MedicinalProductDefinition*>*
< The status within the lifecycle of this item. A high level status, this is not intended to duplicate details carried elsewhere such as legal status, or authorization or marketing status. Binding: publication-status (preferred, The lifecycle status of an artifact.); (xsd)status:CodeableConcept>?
< The date at which the given status became applicable.; (xsd)statusDate:dateTime>?
[]< A total of the complete count of contained items of a particular type/form, independent of sub-packaging or organization. This can be considered as the pack size. This attribute differs from containedItem.amount in that it can give a single aggregated count of all tablet types in a pack, even when these are different manufactured items. For example a pill pack of 21 tablets plus 7 sugar tablets, can be denoted here as '28 tablets'. This attribute is repeatable so that the different item types in one pack type can be counted (e.g. a count of vials and count of syringes). Each repeat must have different units, so that it is clear what the different sets of counted items are, and it is not intended to allow different counts of similar items (e.g. not '2 tubes and 3 tubes'). Repeats are not to be used to represent different pack sizes (e.g. 20 pack vs. 50 pack) - which would be different instances of this resource.; (xsd)containedItemQuantity:Quantity>*
< Textual description. Note that this is not the name of the package or product.; (xsd)description:markdown>?
[]< The legal status of supply of the packaged item as classified by the regulator.; (xsd)legalStatusOfSupply:PackagedProductDefinition.legalStatusOfSupply>*
[]< Allows specifying that an item is on the market for sale, or that it is not available, and the dates and locations associated.; (xsd)marketingStatus:MarketingStatus>*
< Identifies if the package contains different items, such as when a drug product is supplied with another item e.g. a diluent or adjuvant.; (xsd)copackagedIndicator:boolean>?
[]< Manufacturer of this package type. When there are multiple it means these are all possible manufacturers.; (xsd)manufacturer:Organization*>*
[]< Additional information or supporting documentation about the packaged product.; (xsd)attachedDocument:DocumentReference*>*
< A packaging item, as a container for medically related items, possibly with other packaging items within, or a packaging component, such as bottle cap (which is not a device or a medication manufactured item).; (xsd)packaging:PackagedProductDefinition.packaging>?
[]< Allows the key features to be recorded, such as "hospital pack", "nurse prescribable", "calendar pack".; (xsd)characteristic:PackagedProductDefinition.packaging.property>*🔗 The legal status of supply of the packaged item as classified by the regulator.PackagedProductDefinition.legalStatusOfSupply(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The actual status of supply. Conveys in what situation this package type may be supplied for use. Binding: legal-status-of-supply (example, The prescription supply types appropriate to a medicinal product); (xsd)code:CodeableConcept>?
< The place where the legal status of supply applies. When not specified, this indicates it is unknown in this context. Binding: jurisdiction (example, Jurisdiction codes); (xsd)jurisdiction:CodeableConcept>?🔗 A packaging item, as a container for medically related items, possibly with other packaging items within, or a packaging component, such as bottle cap (which is not a device or a medication manufactured item).PackagedProductDefinition.packaging(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< A business identifier that is specific to this particular part of the packaging, often assigned by the manufacturer. Including possibly Data Carrier Identifier (a GS1 barcode).; (xsd)identifier:Identifier>*
< The physical type of the container of the items. Binding: packaging-type (example, A high level categorisation of a package.); (xsd)type:CodeableConcept>?
< Is this a part of the packaging (e.g. a cap or bottle stopper), rather than the packaging itself (e.g. a bottle or vial). The latter type are designed be a container, but the former are not.; (xsd)componentPart:boolean>?
< The quantity of packaging items contained at this layer of the package. This does not relate to the number of contained items but relates solely to the number of packaging items. When looking at the outermost layer it is always 1. If there are two boxes within, at the next layer it would be 2.; (xsd)quantity:integer>?
[]< Material type of the package item. Binding: package-material (example, A material used in the construction of packages and their components.); (xsd)material:CodeableConcept>*
[]< A possible alternate material for this part of the packaging, that is allowed to be used instead of the usual material (e.g. different types of plastic for a blister sleeve). Binding: package-material (example, A material used in the construction of packages and their components.); (xsd)alternateMaterial:CodeableConcept>*
[]< Shelf Life and storage information.; (xsd)shelfLifeStorage:ProductShelfLife>*
[]< Manufacturer of this packaging item. When there are multiple values each one is a potential manufacturer of this packaging item.; (xsd)manufacturer:Organization*>*
[]< General characteristics of this item.; (xsd)property:PackagedProductDefinition.packaging.property>*
[]< The item(s) within the packaging.; (xsd)containedItem:PackagedProductDefinition.packaging.containedItem>*
[]< Allows containers (and parts of containers) within containers, still as a part of a single packaged product. See also PackagedProductDefinition.packaging.containedItem.item(PackagedProductDefinition).; (xsd)packaging:PackagedProductDefinition.packaging>*🔗 The item(s) within the packaging.PackagedProductDefinition.packaging.containedItem(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The actual item(s) of medication, as manufactured, or a device (typically, but not necessarily, a co-packaged one), or other medically related item (such as food, biologicals, raw materials, medical fluids, gases etc.), as contained in the package. This also allows another whole packaged product to be included, which is solely for the case where a package of other entire packages is wanted - such as a wholesale or distribution pack (for layers within one package, use PackagedProductDefinition.packaging.packaging).; (xsd)item:(<BiologicallyDerivedProduct>
|<DeviceDefinition>
|<ManufacturedItemDefinition>
|<NutritionProduct>
|<PackagedProductDefinition>)>
< The number of this type of item within this packaging or for continuous items such as liquids it is the quantity (for example 25ml). See also PackagedProductDefinition.containedItemQuantity (especially the long definition).; (xsd)amount:Quantity>?🔗 General characteristics of this item.PackagedProductDefinition.packaging.property(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A code expressing the type of characteristic. Binding: product-characteristic-codes (example, This value set includes all observable entity codes from SNOMED CT - provided as an exemplar value set.); (xsd)type:CodeableConcept>
(<valueAttachment:Attachment>
|<valueBoolean:boolean>
|<valueCodeableConcept:CodeableConcept>
|<valueDate:date>
|<valueQuantity:Quantity>)?🔗 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(xsd)(doc)=
<#base:DataType>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< The name of the parameter used to allow access to the value of the parameter in evaluation contexts.; (xsd)name:code>?
< Whether the parameter is input or output for the module. Binding: operation-parameter-use (required, Whether the parameter is input or output.); (xsd)use:code>
< The minimum number of times this parameter SHALL appear in the request or response.; (xsd)min:integer>?
< The maximum number of times this element is permitted to appear in the request or response.; (xsd)max:string>?
< A brief discussion of what the parameter is for and how it is used by the module.; (xsd)documentation:string>?
< The type of the parameter. Binding: fhir-types (required, List of FHIR types (resources, data types).); (xsd)type:code>
< If specified, this indicates a profile that the input data must conform to, or that the output data will conform to.; (xsd)profile:StructureDefinition*>?🔗 This resource is used to pass information into and back from an operation (whether invoked directly from REST or within a messaging environment). It is not persisted or allowed to be referenced by other resources. The parameters that may be used are defined by the OperationDefinition resource.Parameters(xsd)(doc)=
<#base:Resource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
[]< A parameter passed to or received from the operation.; (xsd)parameter:Parameters.parameter>*🔗 A parameter passed to or received from the operation.Parameters.parameter(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The name of the parameter (reference to the operation definition).; (xsd)name:string>
(<valueAddress:Address>
|<valueAge:Age>
|<valueAnnotation:Annotation>
|<valueAttachment:Attachment>
|<valueAvailability:Availability>
|<valueBase64Binary:base64Binary>
|<valueBoolean:boolean>
|<valueCode:code>
|<valueCodeableConcept:CodeableConcept>
|<valueCoding:Coding>
|<valueContactDetail:ContactDetail>
|<valueContactPoint:ContactPoint>
|<valueCount:Count>
|<valueDataRequirement:DataRequirement>
|<valueDate:date>
|<valueDateTime:dateTime>
|<valueDecimal:decimal>
|<valueDistance:Distance>
|<valueDosage:Dosage>
|<valueDuration:Duration>
|<valueExpression:Expression>
|<valueExtendedContactDetail:ExtendedContactDetail>
|<valueHumanName:HumanName>
|<valueId:id>
|<valueIdentifier:Identifier>
|<valueInstant:instant>
|<valueInteger:integer>
|<valueInteger64:integer64>
|<valueMarkdown:markdown>
|<valueMeta:Meta>
|<valueMoney:Money>
|<valueOid:oid>
|<valueParameterDefinition:ParameterDefinition>
|<valuePeriod:Period>
|<valuePositiveInt:positiveInt>
|<valueQuantity:Quantity>
|<valueRange:Range>
|<valueRatio:Ratio>
|<valueRatioRange:RatioRange>
|<valueRelatedArtifact:RelatedArtifact>
|<valueResource:Resource>
|<valueSampledData:SampledData>
|<valueSignature:Signature>
|<valueString:string>
|<valueTime:time>
|<valueTiming:Timing>
|<valueTriggerDefinition:TriggerDefinition>
|<valueUnsignedInt:unsignedInt>
|<valueUri:uri>
|<valueUrl:url>
|<valueUsageContext:UsageContext>
|<valueUuid:uuid>)?
< Conveys the content if the parameter is a whole resource. When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to its general resource resolution methods.; (xsd)resource:Resource>?
[]< A named part of a multi-part parameter.; (xsd)part:Parameters.parameter>*🔗 Demographics and other administrative information about an individual or animal receiving care or other health-related services.Patient(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< An identifier for this patient.; (xsd)identifier:Identifier>*
< Whether this patient record is in active use.
Many systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organization's business rules.
It is often used to filter patient lists to exclude inactive patients
Deceased patients may also be marked as inactive for the same reasons, but may be active for some time after death. If a record is inactive, and linked to an active record, then future patient/record updates should occur on the other patient.; (xsd)active:boolean>?
[]< A name associated with the individual. A patient may have multiple names with different uses or applicable periods. For animals, the name is a "HumanName" in the sense that is assigned and used by humans and has the same patterns. Animal names may be communicated as given names, and optionally may include a family name.; (xsd)name:HumanName>*
[]< A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted. A Patient may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and also to help with identification. The address might not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone).; (xsd)telecom:ContactPoint>*
< Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes. The gender might not match the biological sex as determined by genetics or the individual's preferred identification. Note that for both humans and particularly animals, there are other legitimate possibilities than male and female, though the vast majority of systems and contexts only support male and female. Systems providing decision support or enforcing business rules should ideally do this on the basis of Observations dealing with the specific sex or gender aspect of interest (anatomical, chromosomal, social, etc.) However, because these observations are infrequently recorded, defaulting to the administrative gender is common practice. Where such defaulting occurs, rule enforcement should allow for the variation between administrative and biological, chromosomal and other gender aspects. For example, an alert about a hysterectomy on a male should be handled as a warning or overridable error, not a "hard" error. See the Patient Gender and Sex section for additional information about communicating patient gender and sex. Binding: administrative-gender (required, The gender of a person used for administrative purposes.); (xsd)gender:code>?
< The date of birth for the individual. Partial dates are allowed if the specific date of birth is unknown. There is a standard extension "patient-birthTime" available that should be used where Time is required (such as in maternity/infant care systems).; (xsd)birthDate:date>?
< Indicates if the individual is deceased or not. If there's no value in the instance, it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive.; (xsd)deceased:(<boolean>
|<dateTime>)>?
[]< An address for the individual. Patient may have multiple addresses with different uses or applicable periods.; (xsd)address:Address>*
< This field contains a patient's most recent marital (civil) status. Binding: marital-status (extensible, The domestic partnership status of a person.); (xsd)maritalStatus:CodeableConcept>?
< Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer). Where the valueInteger is provided, the number is the birth number in the sequence. E.g. The middle birth in triplets would be valueInteger=2 and the third born would have valueInteger=3 If a boolean value was provided for this triplets example, then all 3 patient records would have valueBoolean=true (the ordering is not indicated).; (xsd)multipleBirth:(<boolean>
|<integer>)>?
[]< Image of the patient. Guidelines:
* Use id photos, not clinical photos.
* Limit dimensions to thumbnail.
* Keep byte count low to ease resource updates.; (xsd)photo:Attachment>*
[]< A contact party (e.g. guardian, partner, friend) for the patient. Contact covers all kinds of contact parties: family members, business contacts, guardians, caregivers. Not applicable to register pedigree and family ties beyond use of having contact.; (xsd)contact:Patient.contact>*
[]< A language which may be used to communicate with the patient about his or her health. If no language is specified, this *implies* that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple Patient.Communication associations. For animals, language is not a relevant field, and should be absent from the instance. If the Patient does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required.; (xsd)communication:Patient.communication>*
[]< Patient's nominated care provider. This may be the primary care provider (in a GP context), or it may be a patient nominated care manager in a community/disability setting, or even organization that will provide people to perform the care provider roles. It is not to be used to record Care Teams, these should be in a CareTeam resource that may be linked to the CarePlan or EpisodeOfCare resources.
Multiple GPs may be recorded against the patient for various reasons, such as a student that has his home GP listed along with the GP at university during the school semesters, or a "fly-in/fly-out" worker that has the onsite GP also included with his home GP to remain aware of medical issues.
Jurisdictions may decide that they can profile this down to 1 if desired, or 1 per type.; (xsd)generalPractitioner:(<Organization>
|<Practitioner>
|<PractitionerRole>)>*
< Organization that is the custodian of the patient record. There is only one managing organization for a specific patient record. Other organizations will have their own Patient record, and may use the Link property to join the records together (or a Person resource which can include confidence ratings for the association).; (xsd)managingOrganization:Organization*>?
[]< Link to a Patient or RelatedPerson resource that concerns the same actual individual. There is no assumption that linked patient records have mutual links.; (xsd)link:Patient.link>*🔗 A language which may be used to communicate with the patient about his or her health. If no language is specified, this *implies* that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple Patient.Communication associations. For animals, language is not a relevant field, and should be absent from the instance. If the Patient does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required.Patient.communication(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. "en" for English, or "en-US" for American English versus "en-AU" for Australian English. The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type. Binding: all-languages (required, IETF language tag for a human language); (xsd)language:CodeableConcept>
< Indicates whether or not the patient prefers this language (over other languages he masters up a certain level). This language is specifically identified for communicating healthcare information.; (xsd)preferred:boolean>?🔗 A contact party (e.g. guardian, partner, friend) for the patient. Contact covers all kinds of contact parties: family members, business contacts, guardians, caregivers. Not applicable to register pedigree and family ties beyond use of having contact.Patient.contact(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< The nature of the relationship between the patient and the contact person. Binding: patient-contactrelationship (extensible, The nature of the relationship between a patient and a contact person for that patient.); (xsd)relationship:CodeableConcept>*
< A name associated with the contact person.; (xsd)name:HumanName>?
[]< A contact detail for the person, e.g. a telephone number or an email address. Contact may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently, and also to help with identification.; (xsd)telecom:ContactPoint>*
< Address for the contact person.; (xsd)address:Address>?
< Administrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes. Binding: administrative-gender (required, The gender of a person used for administrative purposes.); (xsd)gender:code>?
< Organization on behalf of which the contact is acting or for which the contact is working.; (xsd)organization:Organization*>?
< The period during which this contact person or organization is valid to be contacted relating to this patient.; (xsd)period:Period>?🔗 Link to a Patient or RelatedPerson resource that concerns the same actual individual. There is no assumption that linked patient records have mutual links.Patient.link(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Link to a Patient or RelatedPerson resource that concerns the same actual individual. Referencing a RelatedPerson here removes the need to use a Person record to associate a Patient and RelatedPerson as the same individual.; (xsd)other:(<Patient>
|<RelatedPerson>)>
< The type of link between this patient resource and another patient resource. Binding: link-type (required, The type of link between this patient resource and another Patient resource, or Patient/RelatedPerson when using the `seealso` code); (xsd)type:code>🔗 This resource provides the status of the payment for goods and services rendered, and the request and response resource references.PaymentNotice(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< A unique identifier assigned to this payment notice.; (xsd)identifier:Identifier>*
< The status of the resource instance. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. Binding: fm-status (required, A code specifying the state of the resource instance.); (xsd)status:code>
< Reference of resource for which payment is being made.; (xsd)request:Resource*>?
< Reference of response to resource for which payment is being made.; (xsd)response:Resource*>?
< The date when this resource was created.; (xsd)created:dateTime>
< The party who reports the payment notice.; (xsd)reporter:(<Organization>
|<Practitioner>
|<PractitionerRole>)>?
< A reference to the payment which is the subject of this notice.; (xsd)payment:PaymentReconciliation*>?
< The date when the above payment action occurred.; (xsd)paymentDate:date>?
< The party who will receive or has received payment that is the subject of this notification.; (xsd)payee:(<Organization>
|<Practitioner>
|<PractitionerRole>)>?
< The party who is notified of the payment status.; (xsd)recipient:Organization*>
< The amount sent to the payee.; (xsd)amount:Money>
< A code indicating whether payment has been sent or cleared. Typically paid: payment sent, cleared: payment received. Binding: payment-status (example, The payment conveyance status codes.); (xsd)paymentStatus:CodeableConcept>?🔗 This resource provides the details including amount of a payment and allocates the payment items being paid.PaymentReconciliation(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< A unique identifier assigned to this payment reconciliation.; (xsd)identifier:Identifier>*
< Code to indicate the nature of the payment such as payment, adjustment. Binding: payment-type (extensible, ); (xsd)type:CodeableConcept>
< The status of the resource instance. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. Binding: fm-status (required, A code specifying the state of the resource instance.); (xsd)status:code>
< The workflow or activity which gave rise to or during which the payment ocurred such as a kiosk, deposit on account, periodic payment etc. Binding: payment-kind (extensible, ); (xsd)kind:CodeableConcept>?
< The period of time for which payments have been gathered into this bulk payment for settlement.; (xsd)period:Period>?
< The date when the resource was created.; (xsd)created:dateTime>
< Payment enterer if not the actual payment issuer.; (xsd)enterer:(<Organization>
|<Practitioner>
|<PractitionerRole>)>?
< The type of the source such as patient or insurance. Binding: payment-issuertype (extensible, ); (xsd)issuerType:CodeableConcept>?
< The party who generated the payment. This party is also responsible for the reconciliation.; (xsd)paymentIssuer:(<Organization>
|<Patient>
|<RelatedPerson>)>?
< Original request resource reference.; (xsd)request:Task*>?
< The practitioner who is responsible for the services rendered to the patient.; (xsd)requestor:(<Organization>
|<Practitioner>
|<PractitionerRole>)>?
< The outcome of a request for a reconciliation. The resource may be used to indicate that: the request has been held (queued) for processing; that it has been processed and errors found (error); that no errors were found and that some of the adjudication has been undertaken (partial) or that all of the adjudication has been undertaken (complete). Binding: payment-outcome (required, The outcome of the processing.); (xsd)outcome:code>?
< A human readable description of the status of the request for the reconciliation.; (xsd)disposition:string>?
< The date of payment as indicated on the financial instrument.; (xsd)date>
< The location of the site or device for electronic transfers or physical location for cash payments.; (xsd)location:Location*>?
< The means of payment such as check, card cash, or electronic funds transfer. Binding: http://terminology.hl7.org/ValueSet/v2-0570 (extensible, ); (xsd)method:CodeableConcept>?
< The card brand such as debit, Visa, Amex etc. used if a card is the method of payment.; (xsd)cardBrand:string>?
< A portion of the account number, often the last 4 digits, used for verification not charging purposes.; (xsd)accountNumber:string>?
< The year and month (YYYY-MM) when the instrument, typically card, expires.; (xsd)expirationDate:date>?
< The name of the card processor, etf processor, bank for checks.; (xsd)processor:string>?
< The check number, eft reference, car processor reference.; (xsd)referenceNumber:string>?
< An alphanumeric issued by the processor to confirm the successful issuance of payment.; (xsd)authorization:string>?
< The amount offered by the issuer, typically applies to cash when the issuer provides an amount in bank note denominations equal to or excess of the amount actually being paid.; (xsd)tenderedAmount:Money>?
< The amount returned by the receiver which is excess to the amount payable, often referred to as 'change'.; (xsd)returnedAmount:Money>?
< Total payment amount as indicated on the financial instrument.; (xsd)amount:Money>
< Issuer's unique identifier for the payment instrument. For example: EFT number or check number.; (xsd)paymentIdentifier:Identifier>?
[]< Distribution of the payment amount for a previously acknowledged payable.; (xsd)allocation:PaymentReconciliation.allocation>*
< A code for the form to be used for printing the content. May be needed to identify specific jurisdictional forms. Binding: forms (example, The forms codes.); (xsd)formCode:CodeableConcept>?
[]< A note that describes or explains the processing in a human readable form.; (xsd)processNote:PaymentReconciliation.processNote>*🔗 Distribution of the payment amount for a previously acknowledged payable.PaymentReconciliation.allocation(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Unique identifier for the current payment item for the referenced payable.; (xsd)identifier:Identifier>?
< Unique identifier for the prior payment item for the referenced payable.; (xsd)predecessor:Identifier>?
< Specific resource to which the payment/adjustment/advance applies.; (xsd)target:(<Account>
|<Claim>
|<Contract>
|<Encounter>
|<ChargeItem>
|<Invoice>)>?
< Identifies the claim line item, encounter or other sub-element being paid. Note payment may be partial, that is not match the then outstanding balance or amount incurred.; (xsd)targetItem:(<Identifier>
|<positiveInt>
|<string>)>?
< The Encounter to which this payment applies, may be completed by the receiver, used for search.; (xsd)encounter:Encounter*>?
< The Account to which this payment applies, may be completed by the receiver, used for search.; (xsd)account:Account*>?
< Code to indicate the nature of the payment. For example: payment, adjustment, funds advance, etc. Binding: payment-type (extensible, ); (xsd)type:CodeableConcept>?
< The party which submitted the claim or financial transaction.; (xsd)submitter:(<Organization>
|<Practitioner>
|<PractitionerRole>)>?
< A resource, such as a ClaimResponse, which contains a commitment to payment.; (xsd)response:ClaimResponse*>?
< The date from the response resource containing a commitment to pay.; (xsd)date>?
< A reference to the individual who is responsible for inquiries regarding the response and its payment.; (xsd)responsible:PractitionerRole*>?
< The party which is receiving the payment.; (xsd)payee:(<Organization>
|<Practitioner>
|<PractitionerRole>)>?
< The monetary amount allocated from the total payment to the payable.; (xsd)amount:Money>?🔗 A note that describes or explains the processing in a human readable form.PaymentReconciliation.processNote(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The business purpose of the note text. Binding: note-type (required, The presentation types of notes.); (xsd)type:code>?
< The explanation or description associated with the processing.; (xsd)text:string>?🔗 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(xsd)(doc)=
<#base:DataType>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< 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.; (xsd)start:dateTime>?
< The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. The end value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.; (xsd)end:dateTime>?🔗 Permission resource holds access rules for a given data and context.Permission(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< Status. Binding: permission-status (required, Codes identifying the lifecycle stage of a product.); (xsd)status:code>
< The person or entity that asserts the permission.; (xsd)asserter:(<CareTeam>
|<HealthcareService>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>?
[]< The date that permission was asserted.; (xsd)date:dateTime>*
< The period in which the permission is active.; (xsd)validity:Period>?
< The asserted justification for using the data.; (xsd)justification:Permission.justification>?
< Defines a procedure for arriving at an access decision given the set of rules. see [XACML Combining Rules](http://docs.oasis-open.org/xacml/3.0/xacml-3.0-core-spec-cos01-en.html#_Toc325047267) Binding: permission-rule-combining (required, How the rules are to be combined.); (xsd)combining:code>
[]< A set of rules.; (xsd)rule:Permission.rule>*🔗 The asserted justification for using the data.Permission.justification(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< This would be a codeableconcept, or a coding, which can be constrained to , for example, the 6 grounds for processing in GDPR. Binding: consent-policy (example, Regulatory policy examples); (xsd)basis:CodeableConcept>*
[]< Justifing rational. While any resource may be used, DocumentReference, Consent, PlanDefinition, and Contract would be most frequent; (xsd)evidence:Resource*>*🔗 A set of rules.Permission.rule(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< deny | permit. Binding: consent-provision-type (required, How a rule statement is applied.); (xsd)type:code>?
[]< A description or definition of which activities are allowed to be done on the data.; (xsd)data:Permission.rule.data>*
[]< A description or definition of which activities are allowed to be done on the data.; (xsd)activity:Permission.rule.activity>*
[]< What limits apply to the use of the data. Binding: security-label-event-examples (example, Obligations and Refrains); (xsd)limit:CodeableConcept>*🔗 A description or definition of which activities are allowed to be done on the data.Permission.rule.activity(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< The actor(s) authorized for the defined activity.; (xsd)actor:(<CareTeam>
|<Device>
|<Group>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>*
[]< Actions controlled by this Rule. Note that this is the direct action (not the grounds for the action covered in the purpose element). At present, the only action in the understood and tested scope of this resource is 'read'. Binding: consent-action (example, Detailed codes for the action.); (xsd)action:CodeableConcept>*
[]< The purpose for which the permission is given. Binding: http://terminology.hl7.org/ValueSet/v3-PurposeOfUse (preferred, What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels.); (xsd)purpose:CodeableConcept>*🔗 A description or definition of which activities are allowed to be done on the data.Permission.rule.data(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< Explicit FHIR Resource references.; (xsd)resource:Permission.rule.data.resource>*
[]< The data in scope are those with the given codes present in that data .meta.security element. Note the ConfidentialityCode vocabulary indicates the highest value, thus a security label of "R" then it applies to all resources that are labeled "R" or lower. E.g. for Confidentiality, it's a high water mark. For other kinds of security labels, subsumption logic applies. When the purpose of use tag is on the data, access request purpose of use shall not conflict.; (xsd)security:Coding>*
[]< Clinical or Operational Relevant period of time that bounds the data controlled by this rule. This has a different sense to the .validity.; (xsd)period:Period>*
< Used when other data selection elements are insufficient.; (xsd)expression:Expression>?🔗 Explicit FHIR Resource references.Permission.rule.data.resource(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< How the resource reference is interpreted when testing consent restrictions. Binding: consent-data-meaning (required, How a resource reference is interpreted when testing consent restrictions.); (xsd)meaning:code>
< A reference to a specific resource that defines which resources are covered by this consent.; (xsd)reference:Resource*>🔗 Demographics and administrative information about a person independent of a specific health-related context. The Person resource does justice to person registries that keep track of persons regardless of their role. The Person resource is also a primary resource to point to for people acting in a particular role such as SubjectofCare, Practitioner, and Agent. Very few attributes are specific to any role and so Person is kept lean. Most attributes are expected to be tied to the role the Person plays rather than the Person himself. Examples of that are Guardian (SubjectofCare), ContactParty (SubjectOfCare, Practitioner), and multipleBirthInd (SubjectofCare).Person(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< Identifier for a person within a particular scope.; (xsd)identifier:Identifier>*
< Whether this person's record is in active use.; (xsd)active:boolean>?
[]< A name associated with the person. Person may have multiple names with different uses or applicable periods.; (xsd)name:HumanName>*
[]< A contact detail for the person, e.g. a telephone number or an email address. Person may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and also to help with identification.; (xsd)telecom:ContactPoint>*
< Administrative Gender. The gender might not match the biological sex as determined by genetics, or the individual's preferred identification. Note that for both humans and particularly animals, there are other legitimate possibilities than M and F, though a clear majority of systems and contexts only support M and F. Binding: administrative-gender (required, The gender of a person used for administrative purposes.); (xsd)gender:code>?
< The birth date for the person. At least an estimated year should be provided as a guess if the real DOB is unknown.; (xsd)birthDate:date>?
< Indicates if the individual is deceased or not. If there's no value in the instance, it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive.; (xsd)deceased:(<boolean>
|<dateTime>)>?
[]< One or more addresses for the person. Person may have multiple addresses with different uses or applicable periods.; (xsd)address:Address>*
< This field contains a person's most recent marital (civil) status. Many countries maintain a register of births, deaths and marriages, and this would simplify that interaction Binding: marital-status (extensible, The domestic partnership status of a person.); (xsd)maritalStatus:CodeableConcept>?
[]< An image that can be displayed as a thumbnail of the person to enhance the identification of the individual.; (xsd)photo:Attachment>*
[]< A language which may be used to communicate with the person about his or her health. If no language is specified, this *implies* that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple Person.Communication associations. For animals, language is not a relevant field, and should be absent from the instance. If the Patient does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required.
Note that this property should not be used to update any linked/logically linked practitioner resources as it serves as a language that can be used to communicate with patients - however it may be used to inform the value on practitioner, along with their role at the organization (with the practitioner's permission); (xsd)communication:Person.communication>*
< The organization that is the custodian of the person record.; (xsd)managingOrganization:Organization*>?
[]< Link to a resource that concerns the same actual person.; (xsd)link:Person.link>*🔗 A language which may be used to communicate with the person about his or her health. If no language is specified, this *implies* that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple Person.Communication associations. For animals, language is not a relevant field, and should be absent from the instance. If the Patient does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required.
Note that this property should not be used to update any linked/logically linked practitioner resources as it serves as a language that can be used to communicate with patients - however it may be used to inform the value on practitioner, along with their role at the organization (with the practitioner's permission)Person.communication(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. "en" for English, or "en-US" for American English versus "en-AU" for Australian English. The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type. Binding: all-languages (required, IETF language tag for a human language); (xsd)language:CodeableConcept>
< Indicates whether or not the person prefers this language (over other languages he masters up a certain level). This language is specifically identified for communicating healthcare information.; (xsd)preferred:boolean>?🔗 Link to a resource that concerns the same actual person.Person.link(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The resource to which this actual person is associated.; (xsd)target:(<Patient>
|<Person>
|<Practitioner>
|<RelatedPerson>)>
< Level of assurance that this link is associated with the target resource. Binding: identity-assuranceLevel (required, The level of confidence that this link represents the same actual person, based on NIST Authentication Levels.); (xsd)assurance:code>?🔗 This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical and non-clinical artifacts such as clinical decision support rules, order sets, protocols, and drug quality specifications.PlanDefinition(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< An absolute URI that is used to identify this plan definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this plan definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the plan definition is stored on different servers. Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.
The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions).
In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.; (xsd)url:uri>?
[]< A formal identifier that is used to identify this plan definition when it is represented in other formats, or referenced in a specification, model, design or an instance. Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this plan definition outside of FHIR, where it is not possible to use the logical URI.; (xsd)identifier:Identifier>*
< The identifier that is used to identify this version of the plan definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the plan definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts. There may be different plan definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the plan definition with the format [url]|[version]. The version SHOULD NOT contain a '#' - see [Business Version](resource.html#bv-format).; (xsd)version:string>?
< Indicates the mechanism used to compare versions to determine which is more current. If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined. Binding: version-algorithm (extensible, ); (xsd)versionAlgorithm:(<Coding>
|<string>)>?
< A natural language name identifying the plan definition. This name should be usable as an identifier for the module by machine processing applications such as code generation. The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.; (xsd)name:string>?
< A short, descriptive, user-friendly title for the plan definition. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.; (xsd)title:string>?
< An explanatory or alternate title for the plan definition giving additional information about its content.; (xsd)subtitle:string>?
< A high-level category for the plan definition that distinguishes the kinds of systems that would be interested in the plan definition. Binding: plan-definition-type (extensible, The type of PlanDefinition.); (xsd)type:CodeableConcept>?
< The status of this plan definition. Enables tracking the life-cycle of the content. Allows filtering of plan definitions that are appropriate for use versus not.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization). Binding: publication-status (required, The lifecycle status of an artifact.); (xsd)status:code>
< A Boolean value to indicate that this plan definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. Allows filtering of plan definitions that are appropriate for use versus not.; (xsd)experimental:boolean>?
< A code, group definition, or canonical reference that describes or identifies the intended subject of the plan definition. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource. Note that the choice of canonical for the subject element was introduced in R4B to support pharmaceutical quality use cases. To ensure as much backwards-compatibility as possible, it is recommended to only use the new canonical type with these use cases. Binding: participant-resource-types (extensible, The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).); (xsd)subject:(<AdministrableProductDefinition>
|<CodeableConcept>
|<EvidenceVariable>
|<Group>
|<ManufacturedItemDefinition>
|<MedicinalProductDefinition>
|<PackagedProductDefinition>
|<SubstanceDefinition>)>?
< The date (and optionally time) when the plan definition was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the plan definition changes. The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the plan definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)date:dateTime>?
< The name of the organization or individual responsible for the release and ongoing maintenance of the plan definition. Usually an organization but may be an individual. The publisher (or steward) of the plan definition is the organization or individual primarily responsible for the maintenance and upkeep of the plan definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the plan definition. This item SHOULD be populated unless the information is available from context.; (xsd)publisher:string>?
[]< Contact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)contact:ContactDetail>*
< A free text natural language description of the plan definition from a consumer's perspective. This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the plan definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the plan definition is presumed to be the predominant language in the place the plan definition was created).; (xsd)description:markdown>?
[]< The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate plan definition instances. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.; (xsd)useContext:UsageContext>*
[]< A legal or geographic region in which the plan definition is intended to be used. It may be possible for the plan definition to be used in jurisdictions other than those for which it was originally designed or intended.
DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.) Binding: jurisdiction (extensible, Countries and regions within which this artifact is targeted for use.); (xsd)jurisdiction:CodeableConcept>*
< Explanation of why this plan definition is needed and why it has been designed as it has. This element does not describe the usage of the plan definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this plan definition.; (xsd)purpose:markdown>?
< A detailed description of how the plan definition is used from a clinical perspective.; (xsd)usage:markdown>?
< A copyright statement relating to the plan definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the plan definition. The short copyright declaration (e.g. (c) '2015+ xyz organization' should be sent in the copyrightLabel element.; (xsd)copyright:markdown>?
< A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved'). The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.; (xsd)copyrightLabel:string>?
< The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)approvalDate:date>?
< The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. If specified, this date follows the original approval date.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)lastReviewDate:date>?
< The period during which the plan definition content was or is planned to be in active use. The effective period for a plan definition determines when the content is applicable for usage and is independent of publication and review dates. For example, a plan definition intended to be used for the year 2016 might be published in 2015.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)effectivePeriod:Period>?
[]< Descriptive topics related to the content of the plan definition. Topics provide a high-level categorization of the definition that can be useful for filtering and searching. DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'topic' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#topic and useContext.valueCodeableConcept indicating the topic) Binding: definition-topic (example, High-level categorization of the definition, used for searching, sorting, and filtering.); (xsd)topic:CodeableConcept>*
[]< An individiual or organization primarily involved in the creation and maintenance of the content.; (xsd)author:ContactDetail>*
[]< An individual or organization primarily responsible for internal coherence of the content.; (xsd)editor:ContactDetail>*
[]< An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the content. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)reviewer:ContactDetail>*
[]< An individual or organization asserted by the publisher to be responsible for officially endorsing the content for use in some setting. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)endorser:ContactDetail>*
[]< Related artifacts such as additional documentation, justification, or bibliographic references. Each related artifact is either an attachment, or a reference to another resource, but not both.; (xsd)relatedArtifact:RelatedArtifact>*
[]< A reference to a Library resource containing any formal logic used by the plan definition.; (xsd)library:Library*>*
[]< A goal describes an expected outcome that activities within the plan are intended to achieve. For example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, meeting the acceptance criteria for a test as specified by a quality specification, etc.; (xsd)goal:PlanDefinition.goal>*
[]< Actors represent the individuals or groups involved in the execution of the defined set of activities.; (xsd)actor:PlanDefinition.actor>*
[]< An action or group of actions to be taken as part of the plan. For example, in clinical care, an action would be to prescribe a particular indicated medication, or perform a particular test as appropriate. In pharmaceutical quality, an action would be the test that needs to be performed on a drug product as defined in the quality specification. Note that there is overlap between many of the elements defined here and the ActivityDefinition resource. When an ActivityDefinition is referenced (using the definition element), the overlapping elements in the plan override the content of the referenced ActivityDefinition unless otherwise documented in the specific elements. See the PlanDefinition resource for more detailed information.; (xsd)action:PlanDefinition.action>*
< If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example "pain", "on flare-up", etc. Binding: medication-as-needed-reason (example, A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc.); (xsd)asNeeded:(<boolean>
|<CodeableConcept>)>?🔗 An action or group of actions to be taken as part of the plan. For example, in clinical care, an action would be to prescribe a particular indicated medication, or perform a particular test as appropriate. In pharmaceutical quality, an action would be the test that needs to be performed on a drug product as defined in the quality specification. Note that there is overlap between many of the elements defined here and the ActivityDefinition resource. When an ActivityDefinition is referenced (using the definition element), the overlapping elements in the plan override the content of the referenced ActivityDefinition unless otherwise documented in the specific elements. See the PlanDefinition resource for more detailed information.PlanDefinition.action(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< An identifier that is unique within the PlanDefinition to allow linkage within the realized CarePlan and/or RequestOrchestration.; (xsd)linkId:string>?
< A user-visible prefix for the action. For example a section or item numbering such as 1. or A.; (xsd)prefix:string>?
< The textual description of the action displayed to a user. For example, when the action is a test to be performed, the title would be the title of the test such as Assay by HPLC.; (xsd)title:string>?
< A brief description of the action used to provide a summary to display to the user.; (xsd)description:markdown>?
< A text equivalent of the action to be performed. This provides a human-interpretable description of the action when the definition is consumed by a system that might not be capable of interpreting it dynamically.; (xsd)textEquivalent:markdown>?
< Indicates how quickly the action should be addressed with respect to other actions. Binding: request-priority (required, Identifies the level of importance to be assigned to actioning the request.); (xsd)priority:code>?
< A code that provides a meaning, grouping, or classification for the action or action group. For example, a section may have a LOINC code for the section of a documentation template. In pharmaceutical quality, an action (Test) such as pH could be classified as a physical property. Binding: action-code (example, Provides examples of actions to be performed.); (xsd)code:CodeableConcept>?
[]< A description of why this action is necessary or appropriate. This is different than the clinical evidence documentation, it's an actual business description of the reason for performing the action. Binding: action-reason-code (example, Provides examples of reasons for actions to be performed.); (xsd)reason:CodeableConcept>*
[]< Didactic or other informational resources associated with the action that can be provided to the CDS recipient. Information resources can include inline text commentary and links to web resources.; (xsd)documentation:RelatedArtifact>*
[]< Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition. In pharmaceutical quality, a goal represents acceptance criteria (Goal) for a given action (Test), so the goalId would be the unique id of a defined goal element establishing the acceptance criteria for the action.; (xsd)goalId:id>*
< A code, group definition, or canonical reference that describes the intended subject of the action and its children, if any. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource. The subject of an action overrides the subject at a parent action or on the root of the PlanDefinition if specified.
In addition, because the subject needs to be resolved during realization, use of subjects in actions (or in the ActivityDefinition referenced by the action) resolves based on the set of subjects supplied in context and by type (i.e. the patient subject would resolve to a resource of type Patient). Binding: participant-resource-types (extensible, The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).); (xsd)subject:(<CodeableConcept>
|<Group>
|<Resource>)>?
[]< A description of when the action should be triggered. When multiple triggers are specified on an action, any triggering event invokes the action.; (xsd)trigger:TriggerDefinition>*
[]< An expression that describes applicability criteria or start/stop conditions for the action. When multiple conditions of the same kind are present, the effects are combined using AND semantics, so the overall condition is true only if all the conditions are true.; (xsd)condition:PlanDefinition.action.condition>*
[]< Defines input data requirements for the action.; (xsd)input:PlanDefinition.action.input>*
[]< Defines the outputs of the action, if any.; (xsd)output:PlanDefinition.action.output>*
[]< A relationship to another action such as "before" or "30-60 minutes after start of". When an action depends on multiple actions, the meaning is that all actions are dependencies, rather than that any of the actions are a dependency.; (xsd)relatedAction:PlanDefinition.action.relatedAction>*
< An optional value describing when the action should be performed. The intent of the timing element is to provide timing when the action should be performed. As a definitional resource, this timing is interpreted as part of an apply operation so that the timing of the result actions in a CarePlan or RequestOrchestration, for example, would be specified by evaluating the timing definition in the context of the apply and setting the resulting timing on the appropriate elements of the target resource. If the timing is an Age, the activity is expected to be performed when the subject is the given Age. When the timing is a Duration, the activity is expected to be performed within the specified duration from the apply. When the timing is a Range, it may be a range of Ages or Durations, providing a range for the expected timing of the resulting activity. When the timing is a Timing, it is establishing a schedule for the timing of the resulting activity.; (xsd)timing:(<Age>
|<Duration>
|<Range>
|<Timing>)>?
< Identifies the facility where the action will occur; e.g. home, hospital, specific clinic, etc. May reference a specific clinical location or may just identify a type of location.; (xsd)location:Location*>?
[]< Indicates who should participate in performing the action described.; (xsd)participant:PlanDefinition.action.participant>*
< The type of action to perform (create, update, remove). Binding: action-type (extensible, The type of action to be performed.); (xsd)type:CodeableConcept>?
< Defines the grouping behavior for the action and its children. Binding: action-grouping-behavior (required, Defines organization behavior of a group.); (xsd)groupingBehavior:code>?
< Defines the selection behavior for the action and its children. Binding: action-selection-behavior (required, Defines selection behavior of a group.); (xsd)selectionBehavior:code>?
< Defines the required behavior for the action. Binding: action-required-behavior (required, Defines expectations around whether an action or action group is required.); (xsd)requiredBehavior:code>?
< Defines whether the action should usually be preselected. Binding: action-precheck-behavior (required, Defines selection frequency behavior for an action or group.); (xsd)precheckBehavior:code>?
< Defines whether the action can be selected multiple times. Binding: action-cardinality-behavior (required, Defines behavior for an action or a group for how many times that item may be repeated.); (xsd)cardinalityBehavior:code>?
< A reference to an ActivityDefinition that describes the action to be taken in detail, a MessageDefinition describing a message to be snet, a PlanDefinition that describes a series of actions to be taken, a Questionnaire that should be filled out, a SpecimenDefinition describing a specimen to be collected, or an ObservationDefinition that specifies what observation should be captured. Note that the definition is optional, and if no definition is specified, a dynamicValue with a root ($this) path can be used to define the entire resource dynamically.; (xsd)definition:(<ActivityDefinition>
|<MessageDefinition>
|<ObservationDefinition>
|<PlanDefinition>
|<Questionnaire>
|<SpecimenDefinition>
|<uri>)>?
< A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input. Note that when a referenced ActivityDefinition also defines a transform, the transform specified here generally takes precedence. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.; (xsd)transform:StructureMap*>?
[]< Customizations that should be applied to the statically defined resource. For example, if the dosage of a medication must be computed based on the patient's weight, a customization would be used to specify an expression that calculated the weight, and the path on the resource that would contain the result. Dynamic values are applied in the order in which they are defined in the PlanDefinition resource. Note that when dynamic values are also specified by a referenced ActivityDefinition, the dynamicValues from the ActivityDefinition are applied first, followed by the dynamicValues specified here. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.; (xsd)dynamicValue:PlanDefinition.action.dynamicValue>*
[]< Sub actions that are contained within the action. The behavior of this action determines the functionality of the sub-actions. For example, a selection behavior of at-most-one indicates that of the sub-actions, at most one may be chosen as part of realizing the action definition.; (xsd)action:PlanDefinition.action>*🔗 An expression that describes applicability criteria or start/stop conditions for the action. When multiple conditions of the same kind are present, the effects are combined using AND semantics, so the overall condition is true only if all the conditions are true.PlanDefinition.action.condition(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The kind of condition. Applicability criteria are used to determine immediate applicability when a plan definition is applied to a given context. Start and stop criteria are carried through application and used to describe enter/exit criteria for an action. Binding: action-condition-kind (required, Defines the kinds of conditions that can appear on actions.); (xsd)kind:code>
< An expression that returns true or false, indicating whether the condition is satisfied. The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.; (xsd)expression:Expression>?🔗 Customizations that should be applied to the statically defined resource. For example, if the dosage of a medication must be computed based on the patient's weight, a customization would be used to specify an expression that calculated the weight, and the path on the resource that would contain the result. Dynamic values are applied in the order in which they are defined in the PlanDefinition resource. Note that when dynamic values are also specified by a referenced ActivityDefinition, the dynamicValues from the ActivityDefinition are applied first, followed by the dynamicValues specified here. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.PlanDefinition.action.dynamicValue(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The path to the element to be customized. This is the path on the resource that will hold the result of the calculation defined by the expression. The specified path SHALL be a FHIRPath resolvable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. 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). To specify the path to the current action being realized, the %action environment variable is available in this path. For example, to specify the description element of the target action, the path would be %action.description. The path attribute contains a [Simple FHIRPath Subset](fhirpath.html#simple) that allows path traversal, but not calculation.; (xsd)path:string>?
< An expression specifying the value of the customized element. The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.; (xsd)expression:Expression>?🔗 Defines input data requirements for the action.PlanDefinition.action.input(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A human-readable label for the data requirement used to label data flows in BPMN or similar diagrams. Also provides a human readable label when rendering the data requirement that conveys its purpose to human readers.; (xsd)title:string>?
< Defines the data that is to be provided as input to the action.; (xsd)requirement:DataRequirement>?
< Points to an existing input or output element that provides data to this input. The relatedData element allows indicating that an input to a parent action is an input to specific child actions. It also allows the output of one action to be identified as the input to a different action; (xsd)relatedData:id>?🔗 Defines the outputs of the action, if any.PlanDefinition.action.output(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A human-readable label for the data requirement used to label data flows in BPMN or similar diagrams. Also provides a human readable label when rendering the data requirement that conveys its purpose to human readers.; (xsd)title:string>?
< Defines the data that results as output from the action.; (xsd)requirement:DataRequirement>?
< Points to an existing input or output element that is results as output from the action. The relatedData element allows indicating that the output of child action is also the output of a parent action. It also allows the input of one action to be identified as the output of a different action; (xsd)relatedData:string>?🔗 Indicates who should participate in performing the action described.PlanDefinition.action.participant(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A reference to the id element of the actor who will participate in this action.; (xsd)actorId:string>?
< The type of participant in the action. Binding: action-participant-type (required, The type of participant in the activity.); (xsd)type:code>?
< The type of participant in the action.; (xsd)typeCanonical:CapabilityStatement*>?
< The type of participant in the action. When this element is a reference, it SHOULD be a reference to a definitional resource (for example, a location type, rather than a specific location).; (xsd)typeReference:(<CareTeam>
|<Device>
|<DeviceDefinition>
|<Endpoint>
|<Group>
|<HealthcareService>
|<Location>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>?
< The role the participant should play in performing the described action. Binding: http://terminology.hl7.org/ValueSet/action-participant-role (example, Defines roles played by participants for the action.); (xsd)role:CodeableConcept>?
< Indicates how the actor will be involved in the action - author, reviewer, witness, etc. Binding: action-participant-function (example, ); (xsd)function:CodeableConcept>?🔗 A relationship to another action such as "before" or "30-60 minutes after start of". When an action depends on multiple actions, the meaning is that all actions are dependencies, rather than that any of the actions are a dependency.PlanDefinition.action.relatedAction(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The element id of the target related action.; (xsd)targetId:id>
< The relationship of the start of this action to the related action. Binding: action-relationship-type (required, Defines the types of relationships between actions.); (xsd)relationship:code>
< The relationship of the end of this action to the related action. Binding: action-relationship-type (required, Defines the types of relationships between actions.); (xsd)endRelationship:code>?
< A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.; (xsd)offset:(<Duration>
|<Range>)>?🔗 Actors represent the individuals or groups involved in the execution of the defined set of activities.PlanDefinition.actor(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A descriptive label for the actor.; (xsd)title:string>?
< A description of how the actor fits into the overall actions of the plan definition.; (xsd)description:markdown>?
[]< The characteristics of the candidates that could serve as the actor.; (xsd)option:PlanDefinition.actor.option>+🔗 The characteristics of the candidates that could serve as the actor.PlanDefinition.actor.option(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The type of participant in the action. Binding: action-participant-type (required, The type of participant in the activity.); (xsd)type:code>?
< The type of participant in the action.; (xsd)typeCanonical:CapabilityStatement*>?
< The type of participant in the action. When this element is a reference, it SHOULD be a reference to a definitional resource (for example, a location type, rather than a specific location).; (xsd)typeReference:(<CareTeam>
|<Device>
|<DeviceDefinition>
|<Endpoint>
|<Group>
|<HealthcareService>
|<Location>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>?
< The role the participant should play in performing the described action. Binding: http://terminology.hl7.org/ValueSet/action-participant-role (example, ); (xsd)role:CodeableConcept>?🔗 A goal describes an expected outcome that activities within the plan are intended to achieve. For example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, meeting the acceptance criteria for a test as specified by a quality specification, etc.PlanDefinition.goal(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Indicates a category the goal falls within. Binding: goal-category (example, Example codes for grouping goals for filtering or presentation.); (xsd)category:CodeableConcept>?
< Human-readable and/or coded description of a specific desired objective of care, such as "control blood pressure" or "negotiate an obstacle course" or "dance with child at wedding". If no code is available, use CodeableConcept.text. Binding: clinical-findings (example, Describes goals that can be achieved.); (xsd)description:CodeableConcept>
< Identifies the expected level of importance associated with reaching/sustaining the defined goal. Binding: goal-priority (preferred, Indicates the level of importance associated with reaching or sustaining a goal.); (xsd)priority:CodeableConcept>?
< The event after which the goal should begin being pursued. Binding: goal-start-event (example, Identifies the types of events that might trigger the start of a goal.); (xsd)start:CodeableConcept>?
[]< Identifies problems, conditions, issues, or concerns the goal is intended to address. Binding: condition-code (example, Identifies problems, conditions, issues, or concerns that goals may address.); (xsd)addresses:CodeableConcept>*
[]< Didactic or other informational resources associated with the goal that provide further supporting information about the goal. Information resources can include inline text commentary and links to web resources.; (xsd)documentation:RelatedArtifact>*
[]< Indicates what should be done and within what timeframe.; (xsd)target:PlanDefinition.goal.target>*🔗 Indicates what should be done and within what timeframe.PlanDefinition.goal.target(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The parameter whose value is to be tracked, e.g. body weight, blood pressure, or hemoglobin A1c level. Binding: observation-codes (example, Identifies types of parameters that can be tracked to determine goal achievement.); (xsd)measure:CodeableConcept>?
< The target value of the measure to be achieved to signify fulfillment of the goal, e.g. 150 pounds or 7.0%, or in the case of pharmaceutical quality - NMT 0.6%, Clear solution, etc. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any value at or above the low value. A CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the goal.target.measure defines a coded value.; (xsd)detail:(<boolean>
|<CodeableConcept>
|<integer>
|<Quantity>
|<Range>
|<Ratio>
|<string>)>?
< Indicates the timeframe after the start of the goal in which the goal should be met.; (xsd)due:Duration>?🔗 An integer with a value that is positive (e.g. >0)positiveInt(xsd)(doc)=
<#base:integer>
< unique id for the element within a resource (for internal references); (xsd)id:string>?
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< Primitive value for positiveInt; (xsd)value:string>?🔗 A person who is directly or indirectly involved in the provisioning of healthcare or related services.Practitioner(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< An identifier that applies to this person in this role.; (xsd)identifier:Identifier>*
< Whether this practitioner's record is in active use. If the practitioner is not in use by one organization, then it should mark the period on the PractitonerRole with an end date (even if they are active) as they may be active in another role.; (xsd)active:boolean>?
[]< The name(s) associated with the practitioner. The selection of the use property should ensure that there is a single usual name specified, and others use the nickname (alias), old, or other values as appropriate.
In general, select the value to be used in the ResourceReference.display based on this:
1. There is more than 1 name
2. Use = usual
3. Period is current to the date of the usage
4. Use = official
5. Other order as decided by internal business rules.; (xsd)name:HumanName>*
[]< A contact detail for the practitioner, e.g. a telephone number or an email address. Person may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and to help with identification. These typically will have home numbers, or mobile numbers that are not role specific.; (xsd)telecom:ContactPoint>*
< Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes. Binding: administrative-gender (required, The gender of a person used for administrative purposes.); (xsd)gender:code>?
< The date of birth for the practitioner.; (xsd)birthDate:date>?
< Indicates if the practitioner is deceased or not. If there's no value in the instance, it means there is no statement on whether or not the practitioner is deceased. Most systems will interpret the absence of a value as a sign of the person being alive.; (xsd)deceased:(<boolean>
|<dateTime>)>?
[]< Address(es) of the practitioner that are not role specific (typically home address).
Work addresses are not typically entered in this property as they are usually role dependent. The PractitionerRole does not have an address value on it, as it is expected that the location property be used for this purpose (which has an address).; (xsd)address:Address>*
[]< Image of the person.; (xsd)photo:Attachment>*
[]< The official qualifications, certifications, accreditations, training, licenses (and other types of educations/skills/capabilities) that authorize or otherwise pertain to the provision of care by the practitioner.
For example, a medical license issued by a medical board of licensure authorizing the practitioner to practice medicine within a certain locality. The PractitionerRole.specialty defines the functional role that they are practicing at a given organization or location. Those specialties may or might not require a qualification, and are not defined on the practitioner.; (xsd)qualification:Practitioner.qualification>*
[]< A language which may be used to communicate with the practitioner, often for correspondence/administrative purposes.
The `PractitionerRole.communication` property should be used for publishing the languages that a practitioner is able to communicate with patients (on a per Organization/Role basis). If no language is specified, this *implies* that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple Practitioner.Communication associations.
For animals, language is not a relevant field, and should be absent from the instance.; (xsd)communication:Practitioner.communication>*🔗 A language which may be used to communicate with the practitioner, often for correspondence/administrative purposes.
The `PractitionerRole.communication` property should be used for publishing the languages that a practitioner is able to communicate with patients (on a per Organization/Role basis). If no language is specified, this *implies* that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple Practitioner.Communication associations.
For animals, language is not a relevant field, and should be absent from the instance.Practitioner.communication(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. "en" for English, or "en-US" for American English versus "en-AU" for Australian English. The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type. Binding: all-languages (required, IETF language tag for a human language); (xsd)language:CodeableConcept>
< Indicates whether or not the person prefers this language (over other languages he masters up a certain level). This language is specifically identified for communicating directly with the practitioner (typically un-related to patient communications).; (xsd)preferred:boolean>?🔗 The official qualifications, certifications, accreditations, training, licenses (and other types of educations/skills/capabilities) that authorize or otherwise pertain to the provision of care by the practitioner.
For example, a medical license issued by a medical board of licensure authorizing the practitioner to practice medicine within a certain locality. The PractitionerRole.specialty defines the functional role that they are practicing at a given organization or location. Those specialties may or might not require a qualification, and are not defined on the practitioner.Practitioner.qualification(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< An identifier that applies to this person's qualification.; (xsd)identifier:Identifier>*
< Coded representation of the qualification. Binding: http://terminology.hl7.org/ValueSet/v2-0360 (example, Specific qualification the practitioner has to provide a service.); (xsd)code:CodeableConcept>
< Period during which the qualification is valid.; (xsd)period:Period>?
< Organization that regulates and issues the qualification.; (xsd)issuer:Organization*>?🔗 A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time.PractitionerRole(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< Business Identifiers that are specific to a role/location. A specific identifier value (e.g. Minnesota Registration ID) may appear on multiple PractitionerRole instances which could be for different periods, or different Roles (or other reasons). A specific identifier may be included multiple times in the same PractitionerRole instance with different identifier validity periods.; (xsd)identifier:Identifier>*
< Whether this practitioner role record is in active use. Some systems may use this property to mark non-active practitioners, such as those that are not currently employed. If this value is false, you may refer to the period to see when the role was in active use. If there is no period specified, no inference can be made about when it was active.; (xsd)active:boolean>?
< The period during which the person is authorized to act as a practitioner in these role(s) for the organization. If a practitioner is performing a role within an organization over multiple, non-adjacent periods, there should be a distinct PractitionerRole instance for each period. For example, if a nurse is employed at a hospital, leaves the organization for a period of time due to pandemic related stress, but returns post-pandemic to the same job role, there would be two PractitionerRole instances for the different periods of employment.; (xsd)period:Period>?
< Practitioner that is able to provide the defined services for the organization.; (xsd)practitioner:Practitioner*>?
< The organization where the Practitioner performs the roles associated.; (xsd)organization:Organization*>?
[]< Roles which this practitioner is authorized to perform for the organization. A person may have more than one role. Binding: practitioner-role (example, The role a person plays representing an organization.); (xsd)code:CodeableConcept>*
[]< The specialty of a practitioner that describes the functional role they are practicing at a given organization or location. The specialty represents the functional role a practitioner is playing within an organization/location. This role may require the individual have certain qualifications, which would be represented in the Practitioner.qualifications property. Note that qualifications may or might not relate to or be required by the practicing specialty. Binding: c80-practice-codes (preferred, Specific specialty associated with the agency.); (xsd)specialty:CodeableConcept>*
[]< The location(s) at which this practitioner provides care.; (xsd)location:Location*>*
[]< The list of healthcare services that this worker provides for this role's Organization/Location(s).; (xsd)healthcareService:HealthcareService*>*
[]< The contact details of communication devices available relevant to the specific PractitionerRole. This can include addresses, phone numbers, fax numbers, mobile numbers, email addresses and web sites.; (xsd)contact:ExtendedContactDetail>*
[]< Collection of characteristics (attributes). These could be such things as is the service mode used by this role. Binding: service-mode (example, A custom attribute that could be provided at a service (e.g. Wheelchair accessibility).); (xsd)characteristic:CodeableConcept>*
[]< A language the practitioner can use in patient communication. The practitioner may know several languages (listed in practitioner.communication), however these are the languages that could be advertised in a directory for a patient to search. The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems code this but instead have it as free text. Hence CodeableConcept instead of code as the data type.
Note that for non-patient oriented communication, see Practitioner.communication. Note that all 'person' type resources (Person, RelatedPerson, Patient, Practitioner) have a communication structure that includes preferences. Role or service oriented resources such as HealthcareService and PractitionerRole only include languages that are available for interacting with patients. Binding: all-languages (required, IETF language tag for a human language); (xsd)communication:CodeableConcept>*
[]< A collection of times the practitioner is available or performing this role at the location and/or healthcareservice. More detailed availability information may be provided in associated Schedule/Slot resources.
Systems may choose to render availability differently than it is exchanged on the interface. For example, rather than "Mon, Tue, Wed, Thur, Fri from 9am-12am; Mon, Tue, Wed, Thur, Fri from 1pm-5pm" as would be implied by two availableTime repetitions, an application could render this information as "Mon-Fri 9-12am and 1-5pm".
The NotAvailableTime(s) included indicate the general days/periods where the practitioner is not available (for things such as vacation time, or public holidays).; (xsd)availability:Availability>*
[]< Technical endpoints providing access to services operated for the practitioner with this role. Commonly used for locating scheduling services, or identifying where to send referrals electronically.; (xsd)endpoint:Endpoint*>*🔗 The base type for all re-useable types defined that have a simple property.PrimitiveType(xsd)(doc)=
<#base:DataType>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*🔗 An action that is or was performed on or for a patient, practitioner, device, organization, or location. For example, this can be a physical intervention on a patient like an operation, or less invasive like long term services, counseling, or hypnotherapy. This can be a quality or safety inspection for a location, organization, or device. This can be an accreditation procedure on a practitioner for licensing.Procedure(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< Business identifiers assigned to this procedure by the performer or other systems which remain constant as the resource is updated and is propagated from server to server. This is a business identifier, not a resource identifier (see [discussion](resource.html#identifiers)). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and Person resource instances might share the same social insurance number.; (xsd)identifier:Identifier>*
[]< The URL pointing to a FHIR-defined protocol, guideline, order set or other definition that is adhered to in whole or in part by this Procedure.; (xsd)instantiatesCanonical:(<ActivityDefinition>
|<Measure>
|<OperationDefinition>
|<PlanDefinition>
|<Questionnaire>)>*
[]< The URL pointing to an externally maintained protocol, guideline, order set or other definition that is adhered to in whole or in part by this Procedure. This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.; (xsd)instantiatesUri:uri>*
[]< A reference to a resource that contains details of the request for this procedure.; (xsd)basedOn:(<CarePlan>
|<ServiceRequest>)>*
[]< A larger event of which this particular procedure is a component or step. The MedicationAdministration resource has a partOf reference to Procedure, but this is not a circular reference. For example, the anesthesia MedicationAdministration is part of the surgical Procedure (MedicationAdministration.partOf = Procedure). For example, the procedure to insert the IV port for an IV medication administration is part of the medication administration (Procedure.partOf = MedicationAdministration).; (xsd)partOf:(<MedicationAdministration>
|<Observation>
|<Procedure>)>*
< A code specifying the state of the procedure. Generally, this will be the in-progress or completed state. The "unknown" code is not to be used to convey other statuses. The "unknown" code should be used when one of the statuses applies, but the authoring system doesn't know the current state of the procedure.
This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. Binding: event-status (required, A code specifying the state of the procedure.); (xsd)status:code>
< Captures the reason for the current state of the procedure. This is generally only used for "exception" statuses such as "not-done", "suspended" or "aborted". The reason for performing the event at all is captured in reasonCode, not here. Binding: procedure-not-performed-reason (example, A code that identifies the reason a procedure was not performed.); (xsd)statusReason:CodeableConcept>?
[]< A code that classifies the procedure for searching, sorting and display purposes (e.g. "Surgical Procedure"). Binding: procedure-category (example, A code that classifies a procedure for searching, sorting and display purposes.); (xsd)category:CodeableConcept>*
< The specific procedure that is performed. Use text if the exact nature of the procedure cannot be coded (e.g. "Laparoscopic Appendectomy"). Binding: procedure-code (example, A code to identify a specific procedure .); (xsd)code:CodeableConcept>?
< On whom or on what the procedure was performed. This is usually an individual human, but can also be performed on animals, groups of humans or animals, organizations or practitioners (for licensing), locations or devices (for safety inspections or regulatory authorizations). If the actual focus of the procedure is different from the subject, the focus element specifies the actual focus of the procedure.; (xsd)subject:(<Device>
|<Group>
|<Location>
|<Organization>
|<Patient>
|<Practitioner>)>
< Who is the target of the procedure when it is not the subject of record only. If focus is not present, then subject is the focus. If focus is present and the subject is one of the targets of the procedure, include subject as a focus as well. If focus is present and the subject is not included in focus, it implies that the procedure was only targeted on the focus. For example, when a caregiver is given education for a patient, the caregiver would be the focus and the procedure record is associated with the subject (e.g. patient). For example, use focus when recording the target of the education, training, or counseling is the parent or relative of a patient.; (xsd)focus:(<CareTeam>
|<Group>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>
|<Specimen>)>?
< The Encounter during which this Procedure was created or performed or to which the creation of this record is tightly associated. This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter.; (xsd)encounter:Encounter*>?
< Estimated or actual date, date-time, period, or age when the procedure did occur or is occurring. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured. This indicates when the procedure actually occurred or is occurring, not when it was asked/requested/ordered to occur. For the latter, look at the occurence element of the Request this Procedure is "basedOn". The status code allows differentiation of whether the timing reflects a historic event or an ongoing event. Ongoing events should not include an upper bound in the Period or Timing.bounds.
Age is generally used when the patient reports an age at which the procedure was performed. Range is generally used when the patient reports an age range when the procedure was performed, such as sometime between 20-25 years old. dateTime supports a range of precision due to some procedures being reported as past procedures that might not have millisecond precision while other procedures performed and documented during the encounter might have more precise UTC timestamps with timezone.; (xsd)occurrence:(<Age>
|<dateTime>
|<Period>
|<Range>
|<string>
|<Timing>)>?
< The date the occurrence of the procedure was first captured in the record regardless of Procedure.status (potentially after the occurrence of the event).; (xsd)recorded:dateTime>?
< Individual who recorded the record and takes responsibility for its content.; (xsd)recorder:(<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>?
< Indicates if this record was captured as a secondary 'reported' record rather than as an original primary source-of-truth record. It may also indicate the source of the report.; (xsd)reported:(<boolean>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>?
[]< Indicates who or what performed the procedure and how they were involved.; (xsd)performer:Procedure.performer>*
< The location where the procedure actually happened. E.g. a newborn at home, a tracheostomy at a restaurant.; (xsd)location:Location*>?
[]< The coded reason or reference why the procedure was performed. This may be a coded entity of some type, be present as text, or be a reference to one of several resources that justify the procedure. Use Procedure.reason.concept when a code sufficiently describes the reason. Use Procedure.reason.reference when referencing a resource, which allows more information to be conveyed, such as onset date. For a single Procedure.reason, if both Procedure.reason.concept and Procedure.reason.reference are present, they are expected to be consistent with each other. Binding: procedure-reason (example, A code that identifies the reason a procedure is required.); (xsd)reason:(<Condition>
|<DiagnosticReport>
|<DocumentReference>
|<Observation>
|<Procedure>)>*
[]< Detailed and structured anatomical location information. Multiple locations are allowed - e.g. multiple punch biopsies of a lesion. If the use case requires attributes from the BodySite resource (e.g. to identify and track separately) then use the standard extension [http://hl7.org/fhir/StructureDefinition/procedure-targetBodyStructure](http://hl7.org/fhir/extensions/StructureDefinition-procedure-targetBodyStructure.html). Binding: body-site (example, SNOMED CT Body site concepts); (xsd)bodySite:CodeableConcept>*
< The outcome of the procedure - did it resolve the reasons for the procedure being performed? If outcome contains narrative text only, it can be captured using the CodeableConcept.text. Binding: procedure-outcome (example, An outcome of a procedure - whether it was resolved or otherwise.); (xsd)outcome:CodeableConcept>?
[]< This could be a histology result, pathology report, surgical report, etc. There could potentially be multiple reports - e.g. if this was a procedure which took multiple biopsies resulting in a number of anatomical pathology reports.; (xsd)report:(<Composition>
|<DiagnosticReport>
|<DocumentReference>)>*
[]< Any complications that occurred during the procedure, or in the immediate post-performance period. These are generally tracked separately from the notes, which will typically describe the procedure itself rather than any 'post procedure' issues. If complications are only expressed by the narrative text, they can be captured using the CodeableReference.concept.text. Binding: condition-code (example, Codes describing complications that resulted from a procedure.); (xsd)complication:Condition*>*
[]< If the procedure required specific follow up - e.g. removal of sutures. The follow up may be represented as a simple note or could potentially be more complex, in which case the CarePlan resource can be used. Binding: procedure-followup (example, Specific follow up required for a procedure e.g. removal of sutures.); (xsd)followUp:CodeableConcept>*
[]< Any other notes and comments about the procedure.; (xsd)note:Annotation>*
[]< A device that is implanted, removed or otherwise manipulated (calibration, battery replacement, fitting a prosthesis, attaching a wound-vac, etc.) as a focal portion of the Procedure.; (xsd)focalDevice:Procedure.focalDevice>*
[]< Identifies medications, devices and any other substance used as part of the procedure. For devices actually implanted or removed, use Procedure.focalDevice.manipulated. Binding: device-type (example, Codes describing items used during a procedure.); (xsd)used:(<BiologicallyDerivedProduct>
|<Device>
|<Medication>
|<Substance>)>*
[]< Other resources from the patient record that may be relevant to the procedure. The information from these resources was either used to create the instance or is provided to help with its interpretation. This extension should not be used if more specific inline elements or extensions are available.; (xsd)supportingInfo:Resource*>*🔗 A device that is implanted, removed or otherwise manipulated (calibration, battery replacement, fitting a prosthesis, attaching a wound-vac, etc.) as a focal portion of the Procedure.Procedure.focalDevice(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The kind of change that happened to the device during the procedure. Binding: device-action (preferred, A kind of change that happened to the device during the procedure.); (xsd)action:CodeableConcept>?
< The device that was manipulated (changed) during the procedure.; (xsd)manipulated:Device*>🔗 Indicates who or what performed the procedure and how they were involved.Procedure.performer(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Distinguishes the type of involvement of the performer in the procedure. For example, surgeon, anaesthetist, endoscopist. Binding: performer-role (example, A code that identifies the role of a performer of the procedure.); (xsd)function:CodeableConcept>?
< Indicates who or what performed the procedure.; (xsd)actor:(<CareTeam>
|<Device>
|<HealthcareService>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>
< The Organization the Patient, RelatedPerson, Device, CareTeam, and HealthcareService was acting on behalf of. Organization, Patient, RelatedPerson, Device, CareTeam, and HealthcareService can be associated with multiple organizations. This element indicates which organization they were acting on behalf of when performing the action.; (xsd)onBehalfOf:Organization*>?
< Time period during which the performer performed the procedure.; (xsd)period:Period>?🔗 The shelf-life and storage information for a medicinal product item or container can be described using this class.ProductShelfLife(xsd)(doc)=
<#base:BackboneType>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< 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.; (xsd)type:CodeableConcept>?
< 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.; (xsd)period:(<Duration>
|<string>)>?
[]< 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.; (xsd)specialPrecautionsForStorage:CodeableConcept>*🔗 Provenance of a resource is a record that describes entities and processes involved in producing and delivering or otherwise influencing that resource. Provenance provides a critical foundation for assessing authenticity, enabling trust, and allowing reproducibility. Provenance assertions are a form of contextual metadata and can themselves become important records with their own provenance. Provenance statement indicates clinical significance in terms of confidence in authenticity, reliability, and trustworthiness, integrity, and stage in lifecycle (e.g. Document Completion - has the artifact been legally authenticated), all of which may impact security, privacy, and trust policies. Some parties may be duplicated between the target resource and its provenance. For instance, the prescriber is usually (but not always) the author of the prescription resource. This resource is defined with close consideration for W3C Provenance.Provenance(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< The Reference(s) that were generated or updated by the activity described in this resource. A provenance can point to more than one target if multiple resources were created/updated by the same activity. Target references are usually version specific, but might not be, if a version has not been assigned or if the provenance information is part of the set of resources being maintained (i.e. a document). When using the RESTful API, the identity of the resource might not be known (especially not the version specific one); the client may either submit the resource first, and then the provenance, or it may submit both using a single transaction. See the notes on transaction for further discussion.; (xsd)target:Resource*>+
< The period during which the activity occurred. The period can be a little arbitrary; where possible, the time should correspond to human assessment of the activity time.; (xsd)occurred:(<dateTime>
|<Period>)>?
< The instant of time at which the activity was recorded. This can be a little different from the time stamp on the resource if there is a delay between recording the event and updating the provenance and target resource.; (xsd)recorded:instant>?
[]< Policy or plan the activity was defined by. Typically, a single activity may have multiple applicable policy documents, such as patient consent, guarantor funding, etc. For example: Where an OAuth token authorizes, the unique identifier from the OAuth token is placed into the policy element Where a policy engine (e.g. XACML) holds policy logic, the unique policy identifier is placed into the policy element.; (xsd)policy:uri>*
< Where the activity occurred, if relevant.; (xsd)location:Location*>?
[]< The authorization (e.g., PurposeOfUse) that was used during the event being recorded. Binding: http://terminology.hl7.org/ValueSet/v3-PurposeOfUse (example, The authorized purposeOfUse for the activity.); (xsd)authorization:Resource*>*
< An activity is something that occurs over a period of time and acts upon or with entities; it may include consuming, processing, transforming, modifying, relocating, using, or generating entities. Binding: provenance-activity-type (example, The activity that took place.); (xsd)activity:CodeableConcept>?
[]< Allows tracing of authorizatino for the events and tracking whether proposals/recommendations were acted upon.; (xsd)basedOn:(<CarePlan>
|<DeviceRequest>
|<ImmunizationRecommendation>
|<MedicationRequest>
|<NutritionOrder>
|<ServiceRequest>
|<Task>)>*
< The patient element is available to enable deterministic tracking of activities that involve the patient as the subject of the data used in an activity.; (xsd)patient:Patient*>?
< This will typically be the encounter the event occurred, but some events may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission lab tests).; (xsd)encounter:Encounter*>?
[]< An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place. Several agents may be associated (i.e. has some responsibility for an activity) with an activity and vice-versa.; (xsd)agent:Provenance.agent>+
[]< An entity used in this activity.; (xsd)entity:Provenance.entity>*
[]< A digital signature on the target Reference(s). The signer should match a Provenance.agent. The purpose of the signature is indicated.; (xsd)signature:Signature>*🔗 An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place. Several agents may be associated (i.e. has some responsibility for an activity) with an activity and vice-versa.Provenance.agent(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The Functional Role of the agent with respect to the activity. For example: assembler, author, prescriber, signer, investigator, etc. Binding: participation-role-type (example, The type of participation that a provenance agent played with respect to the activity.); (xsd)type:CodeableConcept>?
[]< The structural roles of the agent indicating the agent's competency. The security role enabling the agent with respect to the activity. For example: Chief-of-Radiology, Nurse, Physician, Medical-Student, etc. Binding: security-role-type (example, The role that a provenance agent played with respect to the activity.); (xsd)role:CodeableConcept>*
< Indicates who or what performed in the event.; (xsd)who:(<CareTeam>
|<Device>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>
< The agent that delegated authority to perform the activity performed by the agent.who element.; (xsd)onBehalfOf:(<CareTeam>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>)>?🔗 An entity used in this activity.Provenance.entity(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< How the entity was used during the activity. Binding: provenance-entity-role (required, How an entity was used in an activity.); (xsd)role:code>
< Identity of the Entity used. May be a logical or physical uri and maybe absolute or relative. whatIdentity should be used for entities that are not a Resource type.; (xsd)what:Resource*>
[]< The entity is attributed to an agent to express the agent's responsibility for that entity, possibly along with other agents. This description can be understood as shorthand for saying that the agent was responsible for the activity which used the entity. A usecase where one Provenance.entity.agent is used where the Entity that was used in the creation/updating of the Target, is not in the context of the same custodianship as the Target, and thus the meaning of Provenance.entity.agent is to say that the entity referenced is managed elsewhere and that this Agent provided access to it. This would be similar to where the Entity being referenced is managed outside FHIR, such as through HL7 V2, v3, or XDS. This might be where the Entity being referenced is managed in another FHIR resource server. Thus it explains the Provenance of that Entity's use in the context of this Provenance activity.; (xsd)agent:Provenance.agent>*🔗 Provenance of a resource is a record that describes entities and processes involved in producing and delivering or otherwise influencing that resource. Provenance provides a critical foundation for assessing authenticity, enabling trust, and allowing reproducibility. Provenance assertions are a form of contextual metadata and can themselves become important records with their own provenance. Provenance statement indicates clinical significance in terms of confidence in authenticity, reliability, and trustworthiness, integrity, and stage in lifecycle (e.g. Document Completion - has the artifact been legally authenticated), all of which may impact security, privacy, and trust policies. Some parties may be duplicated between the target resource and its provenance. For instance, the prescriber is usually (but not always) the author of the prescription resource. This resource is defined with close consideration for W3C Provenance.provenance-relevant-history(xsd)(doc)=
<#base:Provenance>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< This points to the version of the resource that was created as a result of this historical record action. Typically only a single resource will be referenced, but if the same action is performed to multiple resources in the context of a transaction, some systems may link multiple resource instances. The reference SHALL be version-specific.; (xsd)target:Resource*>+
< This indicates the time the resource action (creation, revision, deletion, etc.) occurred. Both low and high will be set to the time the record event occurred. (In a future version, this element will likely be a choice with dateTime so that multiple values aren't needed.).; (xsd)occurred:dateTime>
< The instant of time at which the activity was recorded. This can be a little different from the time stamp on the resource if there is a delay between recording the event and updating the provenance and target resource.; (xsd)recorded:instant>?
[]< Policy or plan the activity was defined by. Typically, a single activity may have multiple applicable policy documents, such as patient consent, guarantor funding, etc. For example: Where an OAuth token authorizes, the unique identifier from the OAuth token is placed into the policy element Where a policy engine (e.g. XACML) holds policy logic, the unique policy identifier is placed into the policy element.; (xsd)policy:uri>*
< Where the activity occurred, if relevant.; (xsd)location:Location*>?
[]< The authorization (e.g., PurposeOfUse) that was used during the event being recorded. Plain text reasons can be sent in the "text" component with no codings. Domains may wish to define a constrained terminology. The authorization for the resource's existence of the resource itself will be maintained on the resource, not here. Binding: http://terminology.hl7.org/ValueSet/v3-PurposeOfUse (example, The authorized purposeOfUse for the activity.); (xsd)authorization:Resource*>*
< Indicates what action occurred to the referenced resource. This should be captured at a sufficiently useful level of granularity. For example "suspended" is more useful than "updated". Domains will need to map the listed codes to their own state transitions and may wish to define additional domain-specific fine-grained codes. Binding: provenance-history-record-activity (extensible, Types of activities that are relevant for tracking event history using Provenance.); (xsd)activity:CodeableConcept>
[]< Allows tracing of authorizatino for the events and tracking whether proposals/recommendations were acted upon.; (xsd)basedOn:(<CarePlan>
|<DeviceRequest>
|<ImmunizationRecommendation>
|<MedicationRequest>
|<NutritionOrder>
|<ServiceRequest>
|<Task>)>*
< The patient element is available to enable deterministic tracking of activities that involve the patient as the subject of the data used in an activity.; (xsd)patient:Patient*>?
< This will typically be the encounter the event occurred, but some events may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission lab tests).; (xsd)encounter:Encounter*>?
[]< Who was involved with change. Generally the author will be specified. Others are optional.; (xsd)agent:provenance-relevant-history.agent>+
[]< An entity used in this activity.; (xsd)entity:provenance-relevant-history.entity>*
[]< A digital signature on the target Reference(s). The signer should match a Provenance.agent. The purpose of the signature is indicated.; (xsd)signature:Signature>*
< Author. Several agents may be associated (i.e. has some responsibility for an activity) with an activity and vice-versa.; (xsd)Author:provenance-relevant-history.Author>?🔗 Who was involved with change. Generally the author will be specified. Others are optional.provenance-relevant-history.agent(xsd)(doc)=
<#base:Provenance.agent>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The Functional Role of the agent with respect to the activity. For example: assembler, author, prescriber, signer, investigator, etc. Binding: provenance-history-agent-type (extensible, Types of roles that agents can play when tracking event history using Provenance.); (xsd)type:CodeableConcept>
[]< The structural roles of the agent indicating the agent's competency. The security role enabling the agent with respect to the activity. For example: Chief-of-Radiology, Nurse, Physician, Medical-Student, etc. Binding: security-role-type (example, The role that a provenance agent played with respect to the activity.); (xsd)role:CodeableConcept>*
< Indicates who or what performed in the event.; (xsd)who:(<CareTeam>
|<Device>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>
< The agent that delegated authority to perform the activity performed by the agent.who element.; (xsd)onBehalfOf:(<CareTeam>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>)>?🔗 Author. Several agents may be associated (i.e. has some responsibility for an activity) with an activity and vice-versa.provenance-relevant-history.Author(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The Functional Role of the agent with respect to the activity. For example: assembler, author, prescriber, signer, investigator, etc. Binding: participation-role-type (example, The type of participation that a provenance agent played with respect to the activity.); (xsd)type:CodeableConcept>
[]< The structural roles of the agent indicating the agent's competency. The security role enabling the agent with respect to the activity. For example: Chief-of-Radiology, Nurse, Physician, Medical-Student, etc. Binding: security-role-type (example, The role that a provenance agent played with respect to the activity.); (xsd)role:CodeableConcept>*
< Author Reference.; (xsd)who:(<CareTeam>
|<Device>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>
< The agent that delegated authority to perform the activity performed by the agent.who element.; (xsd)onBehalfOf:(<CareTeam>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>)>?🔗 An entity used in this activity.provenance-relevant-history.entity(xsd)(doc)=
<#base:Provenance.entity>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< How the entity was used during the activity. Binding: provenance-entity-role (required, How an entity was used in an activity.); (xsd)role:code>
< Identity of the Entity used. May be a logical or physical uri and maybe absolute or relative. whatIdentity should be used for entities that are not a Resource type.; (xsd)what:Resource*>
[]< The entity is attributed to an agent to express the agent's responsibility for that entity, possibly along with other agents. This description can be understood as shorthand for saying that the agent was responsible for the activity which used the entity. A usecase where one Provenance.entity.agent is used where the Entity that was used in the creation/updating of the Target, is not in the context of the same custodianship as the Target, and thus the meaning of Provenance.entity.agent is to say that the entity referenced is managed elsewhere and that this Agent provided access to it. This would be similar to where the Entity being referenced is managed outside FHIR, such as through HL7 V2, v3, or XDS. This might be where the Entity being referenced is managed in another FHIR resource server. Thus it explains the Provenance of that Entity's use in the context of this Provenance activity.; (xsd)agent:Provenance.agent>*🔗 This resource allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context.publishableactivitydefinition(xsd)(doc)=
<#base:shareableactivitydefinition>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< An Extension; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< An absolute URI that is used to identify this activity definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this activity definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the activity definition is stored on different servers. Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.
The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions).
In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.; (xsd)url:uri>
[]< A formal identifier that is used to identify this activity definition when it is represented in other formats, or referenced in a specification, model, design or an instance. Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this activity definition outside of FHIR, where it is not possible to use the logical URI.; (xsd)identifier:Identifier>*
< The identifier that is used to identify this version of the activity definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the activity definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active assets. There may be different activity definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the activity definition with the format [url]|[version]. The version SHOULD NOT contain a '#' - see [Business Version](resource.html#bv-format).; (xsd)version:string>
< Indicates the mechanism used to compare versions to determine which is more current. If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined. Binding: version-algorithm (extensible, ); (xsd)versionAlgorithm:(<Coding>
|<string>)>?
< A natural language name identifying the activity definition. This name should be usable as an identifier for the module by machine processing applications such as code generation. The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.; (xsd)name:string>?
< A short, descriptive, user-friendly title for the activity definition. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.; (xsd)title:string>
< An explanatory or alternate title for the activity definition giving additional information about its content.; (xsd)subtitle:string>?
< The status of this activity definition. Enables tracking the life-cycle of the content. Allows filtering of activity definitions that are appropriate for use versus not.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization). Binding: publication-status (required, The lifecycle status of an artifact.); (xsd)status:code>
< A Boolean value to indicate that this activity definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. Allows filtering of activity definitions that are appropriate for use versus not.; (xsd)experimental:boolean>
< A code, group definition, or canonical reference that describes or identifies the intended subject of the activity being defined. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource. Note that the choice of canonical for the subject element was introduced in R4B to support pharmaceutical quality use cases. To ensure as much backwards-compatibility as possible, it is recommended to only use the new canonical type with these use cases. Binding: participant-resource-types (extensible, The possible types of subjects for an activity (E.g. Patient, Practitioner, Organization, Location, etc.).); (xsd)subject:(<AdministrableProductDefinition>
|<CodeableConcept>
|<EvidenceVariable>
|<Group>
|<ManufacturedItemDefinition>
|<MedicinalProductDefinition>
|<PackagedProductDefinition>
|<SubstanceDefinition>)>?
< The date (and optionally time) when the activity definition was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the activity definition changes. The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the activity definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)date:dateTime>
< The name of the organization or individual responsible for the release and ongoing maintenance of the activity definition. Usually an organization but may be an individual. The publisher (or steward) of the activity definition is the organization or individual primarily responsible for the maintenance and upkeep of the activity definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the activity definition. This item SHOULD be populated unless the information is available from context.; (xsd)publisher:string>?
[]< Contact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)contact:ContactDetail>*
< A free text natural language description of the activity definition from a consumer's perspective. This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the activity definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the activity definition is presumed to be the predominant language in the place the activity definition was created).; (xsd)description:markdown>
[]< The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate activity definition instances. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.; (xsd)useContext:UsageContext>*
[]< A legal or geographic region in which the activity definition is intended to be used. It may be possible for the activity definition to be used in jurisdictions other than those for which it was originally designed or intended.
DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.) Binding: jurisdiction (extensible, Countries and regions within which this artifact is targeted for use.); (xsd)jurisdiction:CodeableConcept>*
< Explanation of why this activity definition is needed and why it has been designed as it has. This element does not describe the usage of the activity definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this activity definition.; (xsd)purpose:markdown>?
< A detailed description of how the activity definition is used from a clinical perspective.; (xsd)usage:markdown>?
< A copyright statement relating to the activity definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the activity definition. The short copyright declaration (e.g. (c) '2015+ xyz organization' should be sent in the copyrightLabel element.; (xsd)copyright:markdown>?
< A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved'). The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.; (xsd)copyrightLabel:string>?
< The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)approvalDate:date>?
< The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. If specified, this date follows the original approval date.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)lastReviewDate:date>?
< The period during which the activity definition content was or is planned to be in active use. The effective period for an activity definition determines when the content is applicable for usage and is independent of publication and review dates. For example, a activity intended to be used for the year 2016 might be published in 2015.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)effectivePeriod:Period>?
[]< Descriptive topics related to the content of the activity. Topics provide a high-level categorization of the activity that can be useful for filtering and searching. DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'topic' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#topic and useContext.valueCodeableConcept indicating the topic) Binding: definition-topic (example, High-level categorization of the definition, used for searching, sorting, and filtering.); (xsd)topic:CodeableConcept>*
[]< An individiual or organization primarily involved in the creation and maintenance of the content.; (xsd)author:ContactDetail>*
[]< An individual or organization primarily responsible for internal coherence of the content.; (xsd)editor:ContactDetail>*
[]< An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the content. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)reviewer:ContactDetail>*
[]< An individual or organization asserted by the publisher to be responsible for officially endorsing the content for use in some setting. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)endorser:ContactDetail>*
[]< Related artifacts such as additional documentation, justification, or bibliographic references. Each related artifact is either an attachment, or a reference to another resource, but not both.; (xsd)relatedArtifact:publishableactivitydefinition.relatedArtifact>*
[]< A reference to a Library resource containing any formal logic used by the activity definition.; (xsd)library:Library*>*
< A description of the kind of resource the activity definition is representing. For example, a MedicationRequest, a ServiceRequest, or a CommunicationRequest. The kind element may only specify Request resource types to facilitate considering user input as part of processing the result of any automated clinical reasoning processes. To support creation of event resources, such as Observations, RiskAssessments, and DetectedIssues, use a Task resource with the focus of the task set to the event resource to be created. Note that the kind of resource to be created may determine what types of extensions are permitted. Binding: request-resource-types (required, The kind of activity the definition is describing.); (xsd)kind:code>?
< A profile to which the target of the activity definition is expected to conform.; (xsd)profile:StructureDefinition*>?
< Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter. Tends to be less relevant for activities involving particular products. Binding: procedure-code (example, Detailed type of the activity; e.g. CBC.); (xsd)code:CodeableConcept>?
< Indicates the level of authority/intentionality associated with the activity and where the request should fit into the workflow chain. Binding: request-intent (required, Codes indicating the degree of authority/intentionality associated with a request.); (xsd)intent:code>?
< Indicates how quickly the activity should be addressed with respect to other requests. Binding: request-priority (required, Identifies the level of importance to be assigned to actioning the request.); (xsd)priority:code>?
< Set this to true if the definition is to indicate that a particular activity should NOT be performed. If true, this element should be interpreted to reinforce a negative coding. For example NPO as a code with a doNotPerform of true would still indicate to NOT perform the action. This element is not intended to be used to communicate a decision support response to cancel an order in progress. That should be done with the "remove" type of a PlanDefinition or RequestOrchestration.; (xsd)doNotPerform:boolean>?
< The timing or frequency upon which the described activity is to occur. The intent of the timing element is to provide timing when the action should be performed. As a definitional resource, this timing is interpreted as part of an apply operation so that the timing of the result actions in a CarePlan or RequestOrchestration, for example, would be specified by evaluating the timing definition in the context of the apply and setting the resulting timing on the appropriate elements of the target resource. If the timing is an Age, the activity is expected to be performed when the subject is the given Age. When the timing is a Duration, the activity is expected to be performed within the specified duration from the apply. When the timing is a Range, it may be a range of Ages or Durations, providing a range for the expected timing of the resulting activity. When the timing is a Timing, it is establishing a schedule for the timing of the resulting activity.; (xsd)timing:(<Age>
|<Duration>
|<Range>
|<Timing>)>?
< If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example "pain", "on flare-up", etc. Binding: medication-as-needed-reason (example, A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc.); (xsd)asNeeded:(<boolean>
|<CodeableConcept>)>?
< Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc. May reference a specific clinical location or may just identify a type of location.; (xsd)location:Location*>?
[]< Indicates who should participate in performing the action described.; (xsd)participant:publishableactivitydefinition.participant>*
< Identifies the food, drug or other product being consumed or supplied in the activity. Binding: medication-codes (example, Code describing the type of substance or medication.); (xsd)product:(<CodeableConcept>
|<Ingredient>
|<Medication>
|<Substance>
|<SubstanceDefinition>)>?
< Identifies the quantity expected to be consumed at once (per dose, per meal, etc.).; (xsd)quantity:SimpleQuantity>?
[]< Provides detailed dosage instructions in the same way that they are described for MedicationRequest resources. If a dosage instruction is used, the definition should not specify timing or quantity.; (xsd)dosage:Dosage>*
[]< Indicates the sites on the subject's body where the procedure should be performed (I.e. the target sites). Only used if not implicit in the code found in ServiceRequest.type. Binding: body-site (example, A code that identifies the anatomical location.); (xsd)bodySite:CodeableConcept>*
[]< Defines specimen requirements for the action to be performed, such as required specimens for a lab test.; (xsd)specimenRequirement:SpecimenDefinition*>*
[]< Defines observation requirements for the action to be performed, such as body weight or surface area.; (xsd)observationRequirement:ObservationDefinition*>*
[]< Defines the observations that are expected to be produced by the action.; (xsd)observationResultRequirement:ObservationDefinition*>*
< A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input. Note that if both a transform and dynamic values are specified, the dynamic values will be applied to the result of the transform.; (xsd)transform:StructureMap*>?
[]< Dynamic values that will be evaluated to produce values for elements of the resulting resource. For example, if the dosage of a medication must be computed based on the patient's weight, a dynamic value would be used to specify an expression that calculated the weight, and the path on the request resource that would contain the result. Dynamic values are applied in the order in which they are defined in the ActivityDefinition. Note that if both a transform and dynamic values are specified, the dynamic values will be applied to the result of the transform.; (xsd)dynamicValue:publishableactivitydefinition.dynamicValue>*
[]< Defines a knowledge capability afforded by this knowledge artifact.; (xsd)knowledgeCapability:Extension>*
[]< Defines a knowledge representation level provided by this knowledge artifact.; (xsd)knowledgeRepresentationLevel:Extension>*
[]< A comment containing additional documentation, a review comment, usage guidance, or other relevant information from a particular user.; (xsd)artifactComment:Extension>*🔗 Dynamic values that will be evaluated to produce values for elements of the resulting resource. For example, if the dosage of a medication must be computed based on the patient's weight, a dynamic value would be used to specify an expression that calculated the weight, and the path on the request resource that would contain the result. Dynamic values are applied in the order in which they are defined in the ActivityDefinition. Note that if both a transform and dynamic values are specified, the dynamic values will be applied to the result of the transform.publishableactivitydefinition.dynamicValue(xsd)(doc)=
<#base:ActivityDefinition.dynamicValue>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The path to the element to be customized. This is the path on the resource that will hold the result of the calculation defined by the expression. The specified path SHALL be a FHIRPath resolvable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. 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). The path attribute contains a [Simple FHIRPath Subset](fhirpath.html#simple) that allows path traversal, but not calculation.; (xsd)path:string>
< An expression specifying the value of the customized element. The expression may be inlined, or may be a reference to a named expression within a logic library referenced by the library element.; (xsd)expression:Expression>🔗 Indicates who should participate in performing the action described.publishableactivitydefinition.participant(xsd)(doc)=
<#base:ActivityDefinition.participant>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The type of participant in the action. Binding: action-participant-type (required, The type of participant in the activity.); (xsd)type:code>?
< The type of participant in the action.; (xsd)typeCanonical:CapabilityStatement*>?
< The type of participant in the action. When this element is a reference, it SHOULD be a reference to a definitional resource (for example, a location type, rather than a specific location).; (xsd)typeReference:(<CareTeam>
|<Device>
|<DeviceDefinition>
|<Endpoint>
|<Group>
|<HealthcareService>
|<Location>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>?
< The role the participant should play in performing the described action. Binding: http://terminology.hl7.org/ValueSet/action-participant-role (example, Defines roles played by participants for the action.); (xsd)role:CodeableConcept>?
< Indicates how the actor will be involved in the action - author, reviewer, witness, etc. Binding: action-participant-function (example, ); (xsd)function:CodeableConcept>?🔗 Related artifacts such as additional documentation, justification, or bibliographic references. Each related artifact is either an attachment, or a reference to another resource, but not both.publishableactivitydefinition.relatedArtifact(xsd)(doc)=
<#base:RelatedArtifact>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< The type of relationship to the related artifact. The presence of both sides of a relationship type (e.g. successor and predecessor) is required to support use cases where one side of a relationship is not represented in FHIR. However, this feature SHALL NOT be used to create bi-directional resource links in FHIR instances. Specifically, following the methodology of "new points to old" and "many points to one", when using related artifact elements to describe and reference FHIR resources, the type element SHALL be drawn from the fhir-related-artifact-type ValueSet. Binding: related-artifact-type (required, The type of relationship to the related artifact.); (xsd)type:code>
[]< Provides additional classifiers of the related artifact. Binding: citation-artifact-classifier (example, Additional classifiers for the related artifact.); (xsd)classifier:CodeableConcept>*
< A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index.; (xsd)label:string>?
< A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.; (xsd)display:string>?
< 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.; (xsd)citation:markdown>?
< The document being referenced, represented as an attachment. This is exclusive with the resource element.; (xsd)document:Attachment>?
< The related artifact, 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.; (xsd)resource:Resource*>?
< The related artifact, if the artifact is not a canonical resource, or a resource reference to a canonical resource. If both resource and resourceReference are present, they SHOULD be consistent and reference the same resource. Although relatedArtifact is intended to support references to definitional resources, there are cases where non-definitional resources can be definitional (such as Location where the kind is mode). Related artifacts SHOULD be used to reference definitional resources, and profiles SHOULD be used to make that explicit for particular use cases.; (xsd)resourceReference:Resource*>?
< The publication status of the artifact being referred to. Binding: publication-status (required, Publication status of an artifact being referred to.); (xsd)publicationStatus:code>?
< The date of publication of the artifact being referred to.; (xsd)publicationDate:date>?🔗 The CodeSystem resource is used to declare the existence of and describe a code system or code system supplement and its key properties, and optionally define a part or all of its content.publishablecodesystem(xsd)(doc)=
<#base:shareablecodesystem>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< An Extension; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< An absolute URI that is used to identify this code system when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this code system is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the code system is stored on different servers. This is used in [Coding](datatypes.html#Coding).system. Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.
The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions).
In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.; (xsd)url:uri>
[]< A formal identifier that is used to identify this code system when it is represented in other formats, or referenced in a specification, model, design or an instance. Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this code system outside of FHIR, where it is not possible to use the logical URI. Note that HL7 defines at least three identifiers for many of its code systems - the FHIR canonical URL, the OID and the V2 Table 0396 mnemonic code.; (xsd)identifier:Identifier>*
< The identifier that is used to identify this version of the code system when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the code system author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. This is used in [Coding](datatypes.html#Coding).version. There may be different code system instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the code system with the format [url]|[version]. The version SHOULD NOT contain a '#' - see [Business Version](resource.html#bv-format).; (xsd)version:string>
< Indicates the mechanism used to compare versions to determine which CodeSystem is more current. If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined. Binding: version-algorithm (extensible, ); (xsd)versionAlgorithm:(<Coding>
|<string>)>?
< A natural language name identifying the code system. This name should be usable as an identifier for the module by machine processing applications such as code generation. The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.; (xsd)name:string>?
< A short, descriptive, user-friendly title for the code system. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.; (xsd)title:string>
< The status of this code system. Enables tracking the life-cycle of the content. Allows filtering of code systems that are appropriate for use versus not.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization). Binding: publication-status (required, The lifecycle status of an artifact.); (xsd)status:code>
< A Boolean value to indicate that this code system is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. Allows filtering of code systems that are appropriate for use versus not.; (xsd)experimental:boolean>
< The date (and optionally time) when the code system was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the code system changes. The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the code system. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)date:dateTime>
< The name of the organization or individual responsible for the release and ongoing maintenance of the code system. Usually an organization but may be an individual. The publisher (or steward) of the code system is the organization or individual primarily responsible for the maintenance and upkeep of the code system. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the code system. This item SHOULD be populated unless the information is available from context.; (xsd)publisher:string>?
[]< Contact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)contact:ContactDetail>*
< A free text natural language description of the code system from a consumer's perspective. This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the code system as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the code system is presumed to be the predominant language in the place the code system was created).; (xsd)description:markdown>
[]< The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate code system instances. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.; (xsd)useContext:UsageContext>*
[]< A legal or geographic region in which the code system is intended to be used. It may be possible for the code system to be used in jurisdictions other than those for which it was originally designed or intended.
DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.) Binding: jurisdiction (extensible, Countries and regions within which this artifact is targeted for use.); (xsd)jurisdiction:CodeableConcept>*
< Explanation of why this code system is needed and why it has been designed as it has. This element does not describe the usage of the code system. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this code system.; (xsd)purpose:markdown>?
< A copyright statement relating to the code system and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the code system. ... Sometimes, the copyright differs between the code system and the codes that are included. The copyright statement should clearly differentiate between these when required.; (xsd)copyright:markdown>?
< A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved'). The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.; (xsd)copyrightLabel:string>?
< The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)approvalDate:date>?
< The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. If specified, this date follows the original approval date.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)lastReviewDate:date>?
< The period during which the CodeSystem content was or is planned to be in active use. The effective period for a CodeSystem determines when the content is applicable for usage and is independent of publication and review dates. For example, a system intended to be used for the year 2016 might be published in 2015.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)effectivePeriod:Period>?
[]< Descriptions related to the content of the CodeSystem. Topics provide a high-level categorization as well as keywords for the CodeSystem that can be useful for filtering and searching. DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'topic' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#topic and useContext.valueCodeableConcept indicating the topic) Binding: definition-topic (example, ); (xsd)topic:CodeableConcept>*
[]< An individiual or organization primarily involved in the creation and maintenance of the CodeSystem.; (xsd)author:ContactDetail>*
[]< An individual or organization primarily responsible for internal coherence of the CodeSystem.; (xsd)editor:ContactDetail>*
[]< An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the CodeSystem. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)reviewer:ContactDetail>*
[]< An individual or organization asserted by the publisher to be responsible for officially endorsing the CodeSystem for use in some setting. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)endorser:ContactDetail>*
[]< Related artifacts such as additional documentation, justification, dependencies, bibliographic references, and predecessor and successor artifacts. Each related artifact is either an attachment, or a reference to another resource, but not both.; (xsd)relatedArtifact:RelatedArtifact>*
< If code comparison is case sensitive when codes within this system are compared to each other. If this value is missing, then it is not specified whether a code system is case sensitive or not. When the rule is not known, Postel's law should be followed: produce codes with the correct case, and accept codes in any case. This element is primarily provided to support validation software.; (xsd)caseSensitive:boolean>
< Canonical reference to the value set that contains all codes in the code system independent of code status. The definition of the value set SHALL include all codes from this code system, independent of concept status, and only codes from this code system. It SHALL be immutable, and operations SHOULD support validation of any allowed code compositions.; (xsd)valueSet:ValueSet*>?
< The meaning of the hierarchy of concepts as represented in this resource. Note that other representations might have a different hierarchy or none at all, and represent the information using properties. Binding: codesystem-hierarchy-meaning (required, The meaning of the hierarchy of concepts in a code system.); (xsd)hierarchyMeaning:code>?
< The code system defines a compositional (post-coordination) grammar. Note that the code system resource does not define what the compositional grammar is, only whether or not there is one.; (xsd)compositional:boolean>?
< This flag is used to signify that the code system does not commit to concept permanence across versions. If true, a version must be specified when referencing this code system. Best practice is that code systems do not redefine concepts, or that if concepts are redefined, a new code system definition is created. But this is not always possible, so some code systems may be defined as 'versionNeeded'.
Most code systems occasionally refine the displays defined for concepts between versions. Contexts in which the concept display values are validated may require that the version be specified for some code systems irrespective of the value of this property.; (xsd)versionNeeded:boolean>?
< The extent of the content of the code system (the concepts and codes it defines) are represented in this resource instance. Binding: codesystem-content-mode (required, The extent of the content of the code system (the concepts and codes it defines) are represented in a code system resource.); (xsd)content:code>
< The canonical URL of the code system that this code system supplement is adding designations and properties to. The most common use of a code system supplement is to add additional language support.; (xsd)supplements:CodeSystem*>?
< The total number of concepts defined by the code system. Where the code system has a compositional grammar, the basis of this count is defined by the system steward. The count of concepts defined in this resource cannot be more than this value but may be less for several reasons - see the content element.; (xsd)count:unsignedInt>?
[]< A filter that can be used in a value set compose statement when selecting concepts using a filter. Note that filters defined in code systems usually require custom code on the part of any terminology engine that will make them available for use in value set filters. For this reason, they are generally only seen in high value published terminologies.; (xsd)filter:publishablecodesystem.filter>*
[]< A property defines an additional slot through which additional information can be provided about a concept. Multiple occurrences of CodeSystem.concept.property may occur for a CodeSystem.property where CodeSystem.concept.property.code is the same and CodeSystem.concept.property.value differs. For example: multiple designations for a single concept.; (xsd)property:publishablecodesystem.property>*
[]< Concepts that are in the code system. The concept definitions are inherently hierarchical, but the definitions must be consulted to determine what the meanings of the hierarchical relationships are. If this is empty, it means that the code system resource does not represent the content of the code system.; (xsd)concept:publishablecodesystem.concept>*
[]< Defines a knowledge representation level provided by this knowledge artifact.; (xsd)knowledgeRepresentationLevel:Extension>*
< This text is intended to act as a citation to work done elsewhere that is not part of the current stewarding process where the referenced source is in some way a basis of the current value set definition. This is not intended to be a direct link to another value set. It is only intended to support a link or textual description that indicates related material for the value set.; (xsd)sourceReference:Extension>?
[]< Human readable names for the codesystem.; (xsd)otherName:Extension>*🔗 Concepts that are in the code system. The concept definitions are inherently hierarchical, but the definitions must be consulted to determine what the meanings of the hierarchical relationships are. If this is empty, it means that the code system resource does not represent the content of the code system.publishablecodesystem.concept(xsd)(doc)=
<#base:CodeSystem.concept>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A code - a text symbol - that uniquely identifies the concept within the code system.; (xsd)code>
< A human readable string that is the recommended default way to present this concept to a user.; (xsd)display:string>?
< The formal definition of the concept. The code system resource does not make formal definitions required, because of the prevalence of legacy systems. However, they are highly recommended, as without them there is no formal meaning associated with the concept.; (xsd)definition:string>?
[]< Additional representations for the concept - other languages, aliases, specialized purposes, used for particular purposes, etc. Concepts have both a ```display``` and an array of ```designation```. The display is equivalent to a special designation with an implied ```designation.use``` of "primary code" and a language equal to the [Resource Language](resource.html#language).; (xsd)designation:publishablecodesystem.concept.designation>*
[]< A property value for this concept.; (xsd)property:publishablecodesystem.concept.property>*
[]< Defines children of a concept to produce a hierarchy of concepts. The nature of the relationships is variable (is-a/contains/categorizes) - see hierarchyMeaning.; (xsd)concept:CodeSystem.concept>*🔗 Additional representations for the concept - other languages, aliases, specialized purposes, used for particular purposes, etc. Concepts have both a ```display``` and an array of ```designation```. The display is equivalent to a special designation with an implied ```designation.use``` of "primary code" and a language equal to the [Resource Language](resource.html#language).publishablecodesystem.concept.designation(xsd)(doc)=
<#base:CodeSystem.concept.designation>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The language this designation is defined for. In the absence of a language, the resource language applies. Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< A code that details how this designation would be used. If no use is provided, the designation can be assumed to be suitable for general display to a human user. Binding: designation-use (extensible, Details of how a designation would be used.); (xsd)use:Coding>?
[]< Additional codes that detail how this designation would be used, if there is more than one use. This was added rather than increasing the cardinality of .use to 0..* in order to maintain backward compatibility. Binding: designation-use (extensible, Details of how a designation would be used.); (xsd)additionalUse:Coding>*
< The text value for this designation.; (xsd)value:string>🔗 A property value for this concept.publishablecodesystem.concept.property(xsd)(doc)=
<#base:CodeSystem.concept.property>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A code that is a reference to CodeSystem.property.code.; (xsd)code>
(<valueBoolean:boolean>
|<valueCode:code>
|<valueCoding:Coding>
|<valueDateTime:dateTime>
|<valueDecimal:decimal>
|<valueInteger:integer>
|<valueString:string>)🔗 A filter that can be used in a value set compose statement when selecting concepts using a filter. Note that filters defined in code systems usually require custom code on the part of any terminology engine that will make them available for use in value set filters. For this reason, they are generally only seen in high value published terminologies.publishablecodesystem.filter(xsd)(doc)=
<#base:CodeSystem.filter>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The code that identifies this filter when it is used as a filter in [ValueSet](valueset.html#).compose.include.filter.; (xsd)code>
< A description of how or why the filter is used.; (xsd)description:string>?
[]< A list of operators that can be used with the filter. Binding: filter-operator (required, The kind of operation to perform as a part of a property based filter.); (xsd)operator:code>+
< A description of what the value for the filter should be.; (xsd)value:string>🔗 A property defines an additional slot through which additional information can be provided about a concept. Multiple occurrences of CodeSystem.concept.property may occur for a CodeSystem.property where CodeSystem.concept.property.code is the same and CodeSystem.concept.property.value differs. For example: multiple designations for a single concept.publishablecodesystem.property(xsd)(doc)=
<#base:CodeSystem.property>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A code that is used to identify the property. The code is used internally (in CodeSystem.concept.property.code) and also externally, such as in property filters.; (xsd)code>
< Reference to the formal meaning of the property. One possible source of meaning is the [Concept Properties](codesystem-concept-properties.html) code system.; (xsd)uri>?
< A description of the property- why it is defined, and how its value might be used.; (xsd)description:string>?
< The type of the property value. Properties of type "code" contain a code defined by the code system (e.g. a reference to another defined concept). Binding: concept-property-type (required, The type of a property value.); (xsd)type:code>🔗 A statement of relationships from one set of concepts to one or more other concepts - either concepts in code systems, or data element/data element concepts, or classes in class models.publishableconceptmap(xsd)(doc)=
<#base:shareableconceptmap>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< An Extension; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< An absolute URI that is used to identify this concept map when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this concept map is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the concept map is stored on different servers. Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.
The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions).
In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.; (xsd)url:uri>
[]< A formal identifier that is used to identify this concept map when it is represented in other formats, or referenced in a specification, model, design or an instance. Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this concept map outside of FHIR, where it is not possible to use the logical URI.; (xsd)identifier:Identifier>*
< The identifier that is used to identify this version of the concept map when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the concept map author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. There may be different concept map instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the concept map with the format [url]|[version]. The version SHOULD NOT contain a '#' - see [Business Version](resource.html#bv-format).; (xsd)version:string>
< Indicates the mechanism used to compare versions to determine which ConceptMap is more current. If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined. Binding: version-algorithm (extensible, ); (xsd)versionAlgorithm:(<Coding>
|<string>)>?
< A natural language name identifying the concept map. This name should be usable as an identifier for the module by machine processing applications such as code generation. The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.; (xsd)name:string>?
< A short, descriptive, user-friendly title for the concept map. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.; (xsd)title:string>
< The status of this concept map. Enables tracking the life-cycle of the content. Allows filtering of concept maps that are appropriate for use versus not.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization). Binding: publication-status (required, The lifecycle status of an artifact.); (xsd)status:code>
< A Boolean value to indicate that this concept map is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. Allows filtering of concept maps that are appropriate for use versus not.; (xsd)experimental:boolean>
< The date (and optionally time) when the concept map was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the concept map changes. The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the concept map. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)date:dateTime>
< The name of the organization or individual responsible for the release and ongoing maintenance of the concept map. Usually an organization but may be an individual. The publisher (or steward) of the concept map is the organization or individual primarily responsible for the maintenance and upkeep of the concept map. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the concept map. This item SHOULD be populated unless the information is available from context.; (xsd)publisher:string>?
[]< Contact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)contact:ContactDetail>*
< A free text natural language description of the concept map from a consumer's perspective. The description is not intended to describe the semantics of the concept map. The description should capture its intended use, which is needed for ensuring integrity for its use in models across future changes.; (xsd)description:markdown>
[]< The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate concept map instances. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.; (xsd)useContext:UsageContext>*
[]< A legal or geographic region in which the concept map is intended to be used. It may be possible for the concept map to be used in jurisdictions other than those for which it was originally designed or intended.
DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.) Binding: jurisdiction (extensible, Countries and regions within which this artifact is targeted for use.); (xsd)jurisdiction:CodeableConcept>*
< Explanation of why this concept map is needed and why it has been designed as it has. This element does not describe the usage of the concept map. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this concept map.; (xsd)purpose:markdown>?
< A copyright statement relating to the concept map and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the concept map. Frequently the copyright differs between the concept map and codes that are included. The copyright statement should clearly differentiate between these when required.; (xsd)copyright:markdown>?
< A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved'). The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.; (xsd)copyrightLabel:string>?
< The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)approvalDate:date>?
< The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. If specified, this date follows the original approval date.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)lastReviewDate:date>?
< The period during which the ConceptMap content was or is planned to be in active use. The effective period for a ConceptMap determines when the content is applicable for usage and is independent of publication and review dates. For example, a map intended to be used for the year 2016 might be published in 2015.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)effectivePeriod:Period>?
[]< Descriptions related to the content of the ConceptMap. Topics provide a high-level categorization as well as keywords for the ConceptMap that can be useful for filtering and searching. DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'topic' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#topic and useContext.valueCodeableConcept indicating the topic) Binding: definition-topic (example, ); (xsd)topic:CodeableConcept>*
[]< An individiual or organization primarily involved in the creation and maintenance of the ConceptMap.; (xsd)author:ContactDetail>*
[]< An individual or organization primarily responsible for internal coherence of the ConceptMap.; (xsd)editor:ContactDetail>*
[]< An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the ConceptMap. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)reviewer:ContactDetail>*
[]< An individual or organization asserted by the publisher to be responsible for officially endorsing the ConceptMap for use in some setting. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)endorser:ContactDetail>*
[]< Related artifacts such as additional documentation, justification, dependencies, bibliographic references, and predecessor and successor artifacts. Each related artifact is either an attachment, or a reference to another resource, but not both.; (xsd)relatedArtifact:RelatedArtifact>*
[]< A property defines a slot through which additional information can be provided about a map from source -> target. Properties may be used to supply for example, mapping priority, provenance, presentation hints, flag as experimental, and additional documentation. Multiple occurrences of ConceptMap.group.element.target.property may occur for a ConceptMap.property where ConceptMap.group.element.target.property.code is the same and the values in ConceptMap.group.element.target.property.value differ.; (xsd)property:publishableconceptmap.property>*
[]< An additionalAttribute defines an additional data element found in the source or target data model where the data will come from or be mapped to. Some mappings are based on data in addition to the source data element, where codes in multiple fields are combined to a single field (or vice versa). Additional attributes are used to define additional data elements where mapping data can be found. For an example, see [Specimen Type v2 -> SNOMED CT Mapping(conceptmap-example-specimen-type.html); (xsd)additionalAttribute:publishableconceptmap.additionalAttribute>*
< Identifier for the source value set that contains the concepts that are being mapped and provides context for the mappings. Limits the scope of the map to source codes (ConceptMap.group.element code or valueSet) that are members of this value set. Should be a version specific reference. URIs SHOULD be absolute. If there is no sourceScope or targetScope value set, there is no specified context for the map (not recommended). The sourceScope value set may select codes from either an explicit (standard or local) or implicit code system.; (xsd)sourceScope:(<uri>
|<ValueSet>)>?
< Identifier for the target value set that provides important context about how the mapping choices are made. Limits the scope of the map to target codes (ConceptMap.group.element.target code or valueSet) that are members of this value set. Should be a version specific reference. URIs SHOULD be absolute. If there is no sourceScope or targetScope value set, there is no specified context for the map (not recommended). The targetScope value set may select codes from either an explicit (standard or local) or implicit code system.; (xsd)targetScope:(<uri>
|<ValueSet>)>?
[]< A group of mappings that all have the same source and target system.; (xsd)group:publishableconceptmap.group>*
[]< Defines a knowledge representation level provided by this knowledge artifact.; (xsd)knowledgeRepresentationLevel:Extension>*🔗 An additionalAttribute defines an additional data element found in the source or target data model where the data will come from or be mapped to. Some mappings are based on data in addition to the source data element, where codes in multiple fields are combined to a single field (or vice versa). Additional attributes are used to define additional data elements where mapping data can be found. For an example, see [Specimen Type v2 -> SNOMED CT Mapping(conceptmap-example-specimen-type.html)publishableconceptmap.additionalAttribute(xsd)(doc)=
<#base:ConceptMap.additionalAttribute>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A code that is used to identify this additional data attribute. The code is used internally in ConceptMap.group.element.target.dependsOn.attribute and ConceptMap.group.element.target.product.attribute.; (xsd)code>
< Reference to the formal definition of the source/target data element. For elements defined by the FHIR specification, or using a FHIR logical model, the correct format is {canonical-url}#{element-id}.; (xsd)uri>?
< A description of the additional attribute and/or the data element it refers to - why it is defined, and how the value might be used in mappings, and a discussion of issues associated with the use of the data element.; (xsd)description:string>?
< The type of the source data contained in this concept map for this data element. When the source or target is not content defined by FHIR, some additional application logic might be required to map from the FHIR Datatype to the externally defined content Binding: conceptmap-attribute-type (required, The type of a mapping attribute value.); (xsd)type:code>🔗 A group of mappings that all have the same source and target system.publishableconceptmap.group(xsd)(doc)=
<#base:ConceptMap.group>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< An absolute URI that identifies the source system where the concepts to be mapped are defined. This is not needed if the source value set is specified and it contains concepts from only a single system.; (xsd)source:CodeSystem*>?
< An absolute URI that identifies the target system that the concepts will be mapped to. This is not needed if the target value set is specified and it contains concepts from only a single system. The group target may also be omitted if all of the target element relationship values are 'not-related-to'.; (xsd)target:CodeSystem*>?
[]< Mappings for an individual concept in the source to one or more concepts in the target. Generally, the ideal is that there would only be one mapping for each concept in the source value set, but a given concept may be mapped multiple times with different comments or dependencies.; (xsd)element:publishableconceptmap.group.element>+
< What to do when there is no mapping to a target concept from the source concept and ConceptMap.group.element.noMap is not true. This provides the "default" to be applied when there is no target concept mapping specified or the expansion of ConceptMap.group.element.target.valueSet is empty. The 'unmapped' element is ignored if a code is specified to have relationship = not-related-to or if ConceptMap.group.element.noMap = true.; (xsd)unmapped:publishableconceptmap.group.unmapped>?🔗 Mappings for an individual concept in the source to one or more concepts in the target. Generally, the ideal is that there would only be one mapping for each concept in the source value set, but a given concept may be mapped multiple times with different comments or dependencies.publishableconceptmap.group.element(xsd)(doc)=
<#base:ConceptMap.group.element>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Identity (code or path) or the element/item being mapped.; (xsd)code>?
< The display for the code. The display is only provided to help editors when editing the concept map. The display is ignored when processing the map.; (xsd)display:string>?
< The set of concepts from the ConceptMap.group.source code system which are all being mapped to the target as part of this mapping rule. If the value set expansion is empty then there are no source concepts to map in this rule.; (xsd)valueSet:ValueSet*>?
< If noMap = true this indicates that no mapping to a target concept exists for this source concept. If noMap = true, then the behavior of ConceptMap.group.unmapped (if present) does not apply.; (xsd)noMap:boolean>?
[]< A concept from the target value set that this concept maps to. Ideally there would only be one map, with an 'equivalent' mapping. But multiple maps are allowed for several narrower (i.e. source-is-broader-than-target) options, or to assert that other concepts are not related.; (xsd)target:publishableconceptmap.group.element.target>*🔗 A concept from the target value set that this concept maps to. Ideally there would only be one map, with an 'equivalent' mapping. But multiple maps are allowed for several narrower (i.e. source-is-broader-than-target) options, or to assert that other concepts are not related.publishableconceptmap.group.element.target(xsd)(doc)=
<#base:ConceptMap.group.element.target>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Identity (code or path) or the element/item that the map refers to.; (xsd)code>?
< The display for the code. The display is only provided to help editors when editing the concept map. The display is ignored when processing the map.; (xsd)display:string>?
< The set of concepts from the ConceptMap.group.target code system which are all being mapped to as part of this mapping rule. The effect of using this data element is the same as having multiple ConceptMap.group.element.target elements with one for each concept in the ConceptMap.group.element.target.valueSet value set. If the the value set expansion is empty then the source concept(s) are unmapped and the behavior of ConceptMap.group.unmapped (if present) applies.; (xsd)valueSet:ValueSet*>?
< The relationship between the source and target concepts. The relationship is read from source to target (e.g. source-is-narrower-than-target). This element is labeled as a modifier because it may indicate that there is no mapping. Binding: concept-map-relationship (required, The relationship between concepts.); (xsd)relationship:code>
< A description of status/issues in mapping that conveys additional information not represented in the structured data.; (xsd)comment:string>?
[]< A property value for this source -> target mapping.; (xsd)property:publishableconceptmap.group.element.target.property>*
[]< A set of additional dependencies for this mapping to hold. This mapping is only applicable if the specified data attribute can be resolved, and it has the specified value.; (xsd)dependsOn:publishableconceptmap.group.element.target.dependsOn>*
[]< Product is the output of a ConceptMap that provides additional values that go in other attributes / data elemnts of the target data.; (xsd)product:ConceptMap.group.element.target.dependsOn>*🔗 A set of additional dependencies for this mapping to hold. This mapping is only applicable if the specified data attribute can be resolved, and it has the specified value.publishableconceptmap.group.element.target.dependsOn(xsd)(doc)=
<#base:ConceptMap.group.element.target.dependsOn>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A reference to the additional attribute that holds a value the map depends on.; (xsd)attribute:code>
(<valueBoolean:boolean>
|<valueCode:code>
|<valueCoding:Coding>
|<valueQuantity:Quantity>
|<valueString:string>)?
< This mapping applies if the data element value is a code from this value set.; (xsd)valueSet:ValueSet*>?🔗 A property value for this source -> target mapping.publishableconceptmap.group.element.target.property(xsd)(doc)=
<#base:ConceptMap.group.element.target.property>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A reference to a mapping property defined in ConceptMap.property.; (xsd)code>
(<valueBoolean:boolean>
|<valueCode:code>
|<valueCoding:Coding>
|<valueDateTime:dateTime>
|<valueDecimal:decimal>
|<valueInteger:integer>
|<valueString:string>)🔗 What to do when there is no mapping to a target concept from the source concept and ConceptMap.group.element.noMap is not true. This provides the "default" to be applied when there is no target concept mapping specified or the expansion of ConceptMap.group.element.target.valueSet is empty. The 'unmapped' element is ignored if a code is specified to have relationship = not-related-to or if ConceptMap.group.element.noMap = true.publishableconceptmap.group.unmapped(xsd)(doc)=
<#base:ConceptMap.group.unmapped>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Defines which action to take if there is no match for the source concept in the target system designated for the group. One of 3 actions are possible: use the unmapped source code (this is useful when doing a mapping between versions, and only a few codes have changed), use a fixed code (a default code), or alternatively, a reference to a different concept map can be provided (by canonical URL). Binding: conceptmap-unmapped-mode (required, Defines which action to take if there is no match in the group.); (xsd)mode:code>
< The fixed code to use when the mode = 'fixed' - all unmapped codes are mapped to a single fixed code.; (xsd)code>?
< The display for the code. The display is only provided to help editors when editing the concept map. The display is ignored when processing the map.; (xsd)display:string>?
< The set of fixed codes to use when the mode = 'fixed' - all unmapped codes are mapped to each of the fixed codes.; (xsd)valueSet:ValueSet*>?
< The default relationship value to apply between the source and target concepts when the source code is unmapped and the mode is 'fixed' or 'use-source-code'. This element is labeled as a modifier because it may indicate that there is no mapping. Binding: concept-map-relationship (required, The default relationship value to apply between the source and target concepts when no concept mapping is specified.); (xsd)relationship:code>?
< The canonical reference to an additional ConceptMap resource instance to use for mapping if this ConceptMap resource contains no matching mapping for the source concept.; (xsd)otherMap:ConceptMap*>?🔗 A property defines a slot through which additional information can be provided about a map from source -> target. Properties may be used to supply for example, mapping priority, provenance, presentation hints, flag as experimental, and additional documentation. Multiple occurrences of ConceptMap.group.element.target.property may occur for a ConceptMap.property where ConceptMap.group.element.target.property.code is the same and the values in ConceptMap.group.element.target.property.value differ.publishableconceptmap.property(xsd)(doc)=
<#base:ConceptMap.property>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A code that is used to identify the property. The code is used internally (in ConceptMap.group.element.target.property.code) and also in the $translate operation.; (xsd)code>
< Reference to the formal meaning of the property.; (xsd)uri>?
< A description of the property - why it is defined, and how its value might be used.; (xsd)description:string>?
< The type of the property value. Binding: conceptmap-property-type (required, The type of a property value.); (xsd)type:code>
< The CodeSystem that defines the codes from which values of type ```code``` in property values.; (xsd)system:CodeSystem*>?🔗 The Library resource is a general-purpose container for knowledge asset definitions. It can be used to describe and expose existing knowledge assets such as logic libraries and information model descriptions, as well as to describe a collection of knowledge assets.publishablelibrary(xsd)(doc)=
<#base:shareablelibrary>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< An Extension; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< An absolute URI that is used to identify this library when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this library is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the library is stored on different servers. Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.
The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions).
In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.; (xsd)url:uri>
[]< A formal identifier that is used to identify this library when it is represented in other formats, or referenced in a specification, model, design or an instance. e.g. CMS or NQF identifiers for a measure artifact. Note that at least one identifier is required for non-experimental active artifacts. Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this library outside of FHIR, where it is not possible to use the logical URI.; (xsd)identifier:Identifier>*
< The identifier that is used to identify this version of the library when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the library author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts. There may be different library instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the library with the format [url]|[version]. The version SHOULD NOT contain a '#' - see [Business Version](resource.html#bv-format).; (xsd)version:string>
< Indicates the mechanism used to compare versions to determine which is more current. If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined. Binding: version-algorithm (extensible, ); (xsd)versionAlgorithm:(<Coding>
|<string>)>?
< A natural language name identifying the library. This name should be usable as an identifier for the module by machine processing applications such as code generation. The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.; (xsd)name:string>?
< A short, descriptive, user-friendly title for the library. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.; (xsd)title:string>
< An explanatory or alternate title for the library giving additional information about its content.; (xsd)subtitle:string>?
< The status of this library. Enables tracking the life-cycle of the content. Allows filtering of libraries that are appropriate for use vs. not.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization). Binding: publication-status (required, The lifecycle status of an artifact.); (xsd)status:code>
< A Boolean value to indicate that this library is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. Allows filtering of librarys that are appropriate for use versus not.; (xsd)experimental:boolean>?
< Identifies the type of library such as a Logic Library, Model Definition, Asset Collection, or Module Definition. Binding: library-type (extensible, The type of knowledge asset this library contains.); (xsd)type:CodeableConcept>
< A code or group definition that describes the intended subject of the contents of the library. Binding: participant-resource-types (extensible, The possible types of subjects for a library (E.g. Patient, Practitioner, Organization, Location, etc.).); (xsd)subject:(<CodeableConcept>
|<Group>)>?
< The date (and optionally time) when the library was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the library changes. The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the library. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)date:dateTime>
< The name of the organization or individual responsible for the release and ongoing maintenance of the library. Usually an organization but may be an individual. The publisher (or steward) of the library is the organization or individual primarily responsible for the maintenance and upkeep of the library. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the library. This item SHOULD be populated unless the information is available from context.; (xsd)publisher:string>?
[]< Contact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)contact:ContactDetail>*
< A free text natural language description of the library from a consumer's perspective. This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the library as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the library is presumed to be the predominant language in the place the library was created).; (xsd)description:markdown>
[]< The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate library instances. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.; (xsd)useContext:UsageContext>*
[]< A legal or geographic region in which the library is intended to be used. It may be possible for the library to be used in jurisdictions other than those for which it was originally designed or intended.
DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.) Binding: jurisdiction (extensible, Countries and regions within which this artifact is targeted for use.); (xsd)jurisdiction:CodeableConcept>*
< Explanation of why this library is needed and why it has been designed as it has. This element does not describe the usage of the library. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this library.; (xsd)purpose:markdown>?
< A detailed description of how the library is used from a clinical perspective.; (xsd)usage:markdown>?
< A copyright statement relating to the library and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the library. The short copyright declaration (e.g. (c) '2015+ xyz organization' should be sent in the copyrightLabel element.; (xsd)copyright:markdown>?
< A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved'). The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.; (xsd)copyrightLabel:string>?
< The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)approvalDate:date>?
< The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. If specified, this date follows the original approval date.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)lastReviewDate:date>?
< The period during which the library content was or is planned to be in active use. The effective period for a library determines when the content is applicable for usage and is independent of publication and review dates. For example, a library intended to be used for the year 2016 might be published in 2015.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)effectivePeriod:Period>?
[]< Descriptive topics related to the content of the library. Topics provide a high-level categorization of the library that can be useful for filtering and searching. DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'topic' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#topic and useContext.valueCodeableConcept indicating the topic) Binding: definition-topic (example, High-level categorization of the definition, used for searching, sorting, and filtering.); (xsd)topic:CodeableConcept>*
[]< An individiual or organization primarily involved in the creation and maintenance of the content.; (xsd)author:ContactDetail>*
[]< An individual or organization primarily responsible for internal coherence of the content.; (xsd)editor:ContactDetail>*
[]< An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the content. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)reviewer:ContactDetail>*
[]< An individual or organization asserted by the publisher to be responsible for officially endorsing the content for use in some setting. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)endorser:ContactDetail>*
[]< Related artifacts such as additional documentation, justification, or bibliographic references. Each related artifact is either an attachment, or a reference to another resource, but not both.; (xsd)relatedArtifact:publishablelibrary.relatedArtifact>*
[]< The parameter element defines parameters used by the library.; (xsd)parameter:ParameterDefinition>*
[]< Describes a set of data that must be provided in order to be able to successfully perform the computations defined by the library.; (xsd)dataRequirement:DataRequirement>*
[]< The content of the library as an Attachment. The content may be a reference to a url, or may be directly embedded as a base-64 string. Either way, the contentType of the attachment determines how to interpret the content.; (xsd)content:Attachment>*
[]< Defines a knowledge capability afforded by this knowledge artifact.; (xsd)knowledgeCapability:Extension>*
[]< Defines a knowledge representation level provided by this knowledge artifact.; (xsd)knowledgeRepresentationLevel:Extension>*
[]< A comment containing additional documentation, a review comment, usage guidance, or other relevant information from a particular user.; (xsd)artifactComment:Extension>*
[]< Represents a specific logic definition used by the artifact.; (xsd)logicDefinition:Extension>*🔗 Related artifacts such as additional documentation, justification, or bibliographic references. Each related artifact is either an attachment, or a reference to another resource, but not both.publishablelibrary.relatedArtifact(xsd)(doc)=
<#base:RelatedArtifact>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< The type of relationship to the related artifact. The presence of both sides of a relationship type (e.g. successor and predecessor) is required to support use cases where one side of a relationship is not represented in FHIR. However, this feature SHALL NOT be used to create bi-directional resource links in FHIR instances. Specifically, following the methodology of "new points to old" and "many points to one", when using related artifact elements to describe and reference FHIR resources, the type element SHALL be drawn from the fhir-related-artifact-type ValueSet. Binding: related-artifact-type (required, The type of relationship to the related artifact.); (xsd)type:code>
[]< Provides additional classifiers of the related artifact. Binding: citation-artifact-classifier (example, Additional classifiers for the related artifact.); (xsd)classifier:CodeableConcept>*
< A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index.; (xsd)label:string>?
< A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.; (xsd)display:string>?
< 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.; (xsd)citation:markdown>?
< The document being referenced, represented as an attachment. This is exclusive with the resource element.; (xsd)document:Attachment>?
< The related artifact, 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.; (xsd)resource:Resource*>?
< The related artifact, if the artifact is not a canonical resource, or a resource reference to a canonical resource. If both resource and resourceReference are present, they SHOULD be consistent and reference the same resource. Although relatedArtifact is intended to support references to definitional resources, there are cases where non-definitional resources can be definitional (such as Location where the kind is mode). Related artifacts SHOULD be used to reference definitional resources, and profiles SHOULD be used to make that explicit for particular use cases.; (xsd)resourceReference:Resource*>?
< The publication status of the artifact being referred to. Binding: publication-status (required, Publication status of an artifact being referred to.); (xsd)publicationStatus:code>?
< The date of publication of the artifact being referred to.; (xsd)publicationDate:date>?🔗 The Measure resource provides the definition of a quality measure.publishablemeasure(xsd)(doc)=
<#base:shareablemeasure>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< An Extension; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< An absolute URI that is used to identify this measure when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this measure is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the measure is stored on different servers. Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.
The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions).
In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.; (xsd)url:uri>
[]< A formal identifier that is used to identify this measure when it is represented in other formats, or referenced in a specification, model, design or an instance. Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this measure outside of FHIR, where it is not possible to use the logical URI.; (xsd)identifier:Identifier>*
< The identifier that is used to identify this version of the measure when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the measure author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts. There may be different measure instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the measure with the format [url]|[version]. The version SHOULD NOT contain a '#' - see [Business Version](resource.html#bv-format).; (xsd)version:string>
< Indicates the mechanism used to compare versions to determine which is more current. If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined. Binding: version-algorithm (extensible, ); (xsd)versionAlgorithm:(<Coding>
|<string>)>?
< A natural language name identifying the measure. This name should be usable as an identifier for the module by machine processing applications such as code generation. The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.; (xsd)name:string>?
< A short, descriptive, user-friendly title for the measure. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.; (xsd)title:string>
< An explanatory or alternate title for the measure giving additional information about its content.; (xsd)subtitle:string>?
< The status of this measure. Enables tracking the life-cycle of the content. Allows filtering of measures that are appropriate for use versus not.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization). Binding: publication-status (required, The lifecycle status of an artifact.); (xsd)status:code>
< A Boolean value to indicate that this measure is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. Allows filtering of measures that are appropriate for use versus not.; (xsd)experimental:boolean>?
< The intended subjects for the measure. If this element is not provided, a Patient subject is assumed, but the subject of the measure can be anything. The subject of the measure is critical in interpreting the criteria definitions, as the logic in the measures is evaluated with respect to a particular subject. This corresponds roughly to the notion of a Compartment in that it limits what content is available based on its relationship to the subject. In CQL, this corresponds to the context declaration. Binding: participant-resource-types (extensible, The possible types of subjects for a measure (E.g. Patient, Practitioner, Organization, Location, etc.).); (xsd)subject:(<CodeableConcept>
|<Group>)>?
< The population basis specifies the type of elements in the population. For a subject-based measure, this is boolean (because the subject and the population basis are the same, and the population criteria define yes/no values for each individual in the population). For measures that have a population basis that is different than the subject, this element specifies the type of the population basis. For example, an encounter-based measure has a subject of Patient and a population basis of Encounter, and the population criteria all return lists of Encounters. For a subject-based measure, the population basis is simply boolean; all the criteria are expressed as true/false conditions that determine membership of an individual case in the population. For non-subject-based measures, the population basis can be any resource type, and the criteria are queries that return the subject's contribution to the population as a list of that resource type. For example, for a procedure-based measure, the population criteria would return lists of procedures that should be included in each population. Binding: fhir-types (required, ); (xsd)basis:code>?
< The date (and optionally time) when the measure was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the measure changes. The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the measure. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)date:dateTime>
< The name of the organization or individual responsible for the release and ongoing maintenance of the measure. Usually an organization but may be an individual. The publisher (or steward) of the measure is the organization or individual primarily responsible for the maintenance and upkeep of the measure. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the measure. This item SHOULD be populated unless the information is available from context.; (xsd)publisher:string>?
[]< Contact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)contact:ContactDetail>*
< A free text natural language description of the measure from a consumer's perspective. This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the measure as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the measure is presumed to be the predominant language in the place the measure was created).; (xsd)description:markdown>
[]< The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate measure instances. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.; (xsd)useContext:UsageContext>*
[]< A legal or geographic region in which the measure is intended to be used. It may be possible for the measure to be used in jurisdictions other than those for which it was originally designed or intended.
DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.) Binding: jurisdiction (extensible, Countries and regions within which this artifact is targeted for use.); (xsd)jurisdiction:CodeableConcept>*
< Explanation of why this measure is needed and why it has been designed as it has. This element does not describe the usage of the measure. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this measure.; (xsd)purpose:markdown>?
< A detailed description, from a clinical perspective, of how the measure is used. This metadata element was typically referred to as Guidance in HQMF; (xsd)usage:markdown>?
< A copyright statement relating to the measure and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the measure. The short copyright declaration (e.g. (c) '2015+ xyz organization' should be sent in the copyrightLabel element.; (xsd)copyright:markdown>?
< A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved'). The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.; (xsd)copyrightLabel:string>?
< The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)approvalDate:date>?
< The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. If specified, this date follows the original approval date.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)lastReviewDate:date>?
< The period during which the measure content was or is planned to be in active use. The effective period for a measure determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 might be published in 2015.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)effectivePeriod:Period>?
[]< Descriptive topics related to the content of the measure. Topics provide a high-level categorization grouping types of measures that can be useful for filtering and searching. DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'topic' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#topic and useContext.valueCodeableConcept indicating the topic) Binding: definition-topic (example, High-level categorization of the definition, used for searching, sorting, and filtering.); (xsd)topic:CodeableConcept>*
[]< An individiual or organization primarily involved in the creation and maintenance of the content.; (xsd)author:ContactDetail>*
[]< An individual or organization primarily responsible for internal coherence of the content.; (xsd)editor:ContactDetail>*
[]< An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the content. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)reviewer:ContactDetail>*
[]< An individual or organization asserted by the publisher to be responsible for officially endorsing the content for use in some setting. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)endorser:ContactDetail>*
[]< Related artifacts such as additional documentation, justification, or bibliographic references. Each related artifact is either an attachment, or a reference to another resource, but not both.; (xsd)relatedArtifact:publishablemeasure.relatedArtifact>*
[]< A reference to a Library resource containing the formal logic used by the measure.; (xsd)library:Library*>*
< Notices and disclaimers regarding the use of the measure or related to intellectual property (such as code systems) referenced by the measure.; (xsd)disclaimer:markdown>?
< Indicates how the calculation is performed for the measure, including proportion, ratio, continuous-variable, and cohort. The value set is extensible, allowing additional measure scoring types to be represented. Binding: http://terminology.hl7.org/ValueSet/measure-scoring (extensible, The scoring type of the measure.); (xsd)scoring:CodeableConcept>?
< Defines the expected units of measure for the measure score. This element SHOULD be specified as a UCUM unit. When this element is specified, implementations are expected to report measure scores in the specified units. Note that this may involve unit conversion if the expected units are different than the units of the resulting score calculation. In this case, unit conversions SHALL be performed according to the unit conversion semantics specified by UCUM. Binding: measure-scoring-unit (example, ); (xsd)scoringUnit:CodeableConcept>?
< If this is a composite measure, the scoring method used to combine the component measures to determine the composite score. Binding: composite-measure-scoring (extensible, The composite scoring method of the measure.); (xsd)compositeScoring:CodeableConcept>?
[]< Indicates whether the measure is used to examine a process, an outcome over time, a patient-reported outcome, or a structure measure such as utilization. Binding: measure-type (extensible, The type of measure (includes codes from 2.16.840.1.113883.1.11.20368).); (xsd)type:CodeableConcept>*
< A description of the risk adjustment factors that may impact the resulting score for the measure and how they may be accounted for when computing and reporting measure results. Describes the method of adjusting for clinical severity and conditions present at the start of care that can influence patient outcomes for making valid comparisons of outcome measures across providers. Indicates whether a measure is subject to the statistical process for reducing, removing, or clarifying the influences of confounding factors to allow for more useful comparisons.; (xsd)riskAdjustment:markdown>?
< Describes how to combine the information calculated, based on logic in each of several populations, into one summarized result. The measure rate for an organization or clinician is based upon the entities’ aggregate data and summarizes the performance of the entity over a given time period (e.g., monthly, quarterly, yearly). The aggregated data are derived from the results of a specific measure algorithm and, if appropriate, the application of specific risk adjustment models. Can also be used to describe how to risk adjust the data based on supplemental data elements described in the eMeasure (e.g., pneumonia hospital measures antibiotic selection in the ICU versus non-ICU and then the roll-up of the two). This could be applied to aggregated cohort measure definitions (e.g., CDC's aggregate reporting for TB at the state level).; (xsd)rateAggregation:markdown>?
< Provides a succinct statement of the need for the measure. Usually includes statements pertaining to importance criterion: impact, gap in care, and evidence.; (xsd)rationale:markdown>?
< Provides a summary of relevant clinical guidelines or other clinical recommendations supporting the measure.; (xsd)clinicalRecommendationStatement:markdown>?
< Information on whether an increase or decrease in score is the preferred result (e.g., a higher score indicates better quality OR a lower score indicates better quality OR quality is within a range). Binding: measure-improvement-notation (required, Observation values that indicate what change in a measurement value or score is indicative of an improvement in the measured item or scored issue.); (xsd)improvementNotation:CodeableConcept>?
[]< Provides a description of an individual term used within the measure.; (xsd)term:publishablemeasure.term>*
< Additional guidance for the measure including how it can be used in a clinical context, and the intent of the measure. NOTE: This element is deprecated in favor of the usage element; (xsd)guidance:markdown>?
[]< A group of population criteria for the measure.; (xsd)group:publishablemeasure.group>*
[]< The supplemental data criteria for the measure report, specified as either the name of a valid CQL expression within a referenced library, or a valid FHIR Resource Path. Note that supplemental data are reported as resources for each patient and referenced in the supplementalData element of the MeasureReport. If the supplementalData expression results in a value other than a resource, it is reported using an Observation resource, typically contained in the resulting MeasureReport. See the MeasureReport resource and the Quality Reporting topic for more information.; (xsd)supplementalData:publishablemeasure.supplementalData>*
[]< Defines a knowledge capability afforded by this knowledge artifact.; (xsd)knowledgeCapability:Extension>*
[]< Defines a knowledge representation level provided by this knowledge artifact.; (xsd)knowledgeRepresentationLevel:Extension>*
[]< A comment containing additional documentation, a review comment, usage guidance, or other relevant information from a particular user.; (xsd)artifactComment:Extension>*🔗 A group of population criteria for the measure.publishablemeasure.group(xsd)(doc)=
<#base:Measure.group>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< An identifier that is unique within the Measure allowing linkage to the equivalent item in a MeasureReport resource. This ''can'' be a meaningful identifier (e.g. a LOINC code) but is not intended to have any meaning. GUIDs or sequential numbers are appropriate here.
LinkIds can have whitespaces and slashes by design. Tooling should not rely on linkIds being valid XHTML element IDs, and should not directly embed them as such; (xsd)linkId:string>?
< Indicates a meaning for the group. This can be as simple as a unique identifier, or it can establish meaning in a broader context by drawing from a terminology, allowing groups to be correlated across measures. Binding: measure-group-example (example, Example of measure groups.); (xsd)code:CodeableConcept>?
< The human readable description of this population group.; (xsd)description:markdown>?
[]< Indicates whether the measure is used to examine a process, an outcome over time, a patient-reported outcome, or a structure measure such as utilization. When specified at the group level, defines the measure type for this specific group. If not specified, the measureType of the group is determined by the root type element Binding: measure-type (extensible, ); (xsd)type:CodeableConcept>*
< The intended subjects for the measure. If this element is not provided, a Patient subject is assumed, but the subject of the measure can be anything. The subject of the measure is critical in interpreting the criteria definitions, as the logic in the measures is evaluated with respect to a particular subject. This corresponds roughly to the notion of a Compartment in that it limits what content is available based on its relationship to the subject. In CQL, this corresponds to the context declaration. Binding: participant-resource-types (extensible, The possible types of subjects for a measure (E.g. Patient, Practitioner, Organization, Location, etc.).); (xsd)subject:(<CodeableConcept>
|<Group>)>?
< The population basis specifies the type of elements in the population. For a subject-based measure, this is boolean (because the subject and the population basis are the same, and the population criteria define yes/no values for each individual in the population). For measures that have a population basis that is different than the subject, this element specifies the type of the population basis. For example, an encounter-based measure has a subject of Patient and a population basis of Encounter, and the population criteria all return lists of Encounters. When specified at the group level, defines the population basis for this specific group. If not specified, the basis for the group is determined by the root basis element Binding: fhir-types (required, ); (xsd)basis:code>?
< Indicates how the calculation is performed for the measure, including proportion, ratio, continuous-variable, and cohort. The value set is extensible, allowing additional measure scoring types to be represented. When specified at the group level, defines the scoring for this specific group. If not specified, scoring for this group is determined by the root scoring element Binding: http://terminology.hl7.org/ValueSet/measure-scoring (extensible, ); (xsd)scoring:CodeableConcept>?
< Defines the expected units of measure for the measure score. This element SHOULD be specified as a UCUM unit. When specified at the group level, this defines the scoringUnit for this specific group. If not specified, the scoringUnit for this group is determined by the root scoringUnit element. As with the root element, when this element is specified, implementations are expected to report measure scores in the specified units. Note that this may involve unit conversion if the expected units are different than the units of the resulting score calculation. In this case, unit conversions SHALL be performed according to the unit conversion semantics specified by UCUM. Binding: measure-scoring-unit (example, ); (xsd)scoringUnit:CodeableConcept>?
< Describes how to combine the information calculated, based on logic in each of several populations, into one summarized result. The measure rate for an organization or clinician is based upon the entities’ aggregate data and summarizes the performance of the entity over a given time period (e.g., monthly, quarterly, yearly). The aggregated data are derived from the results of a specific measure algorithm and, if appropriate, the application of specific risk adjustment models. Can also be used to describe how to risk adjust the data based on supplemental data elements described in the eMeasure (e.g., pneumonia hospital measures antibiotic selection in the ICU versus non-ICU and then the roll-up of the two). This could be applied to aggregated cohort measure definitions (e.g., CDC's aggregate reporting for TB at the state level).; (xsd)rateAggregation:markdown>?
< Information on whether an increase or decrease in score is the preferred result (e.g., a higher score indicates better quality OR a lower score indicates better quality OR quality is within a range). When specified at the group level, this element defines the improvementNotation for this specific group. If not specified, improvementNotation for this group is determined by the root improvementNotation element Binding: measure-improvement-notation (required, ); (xsd)improvementNotation:CodeableConcept>?
[]< A reference to a Library resource containing the formal logic used by the measure group.; (xsd)library:Library*>*
[]< A population criteria for the measure.; (xsd)population:publishablemeasure.group.population>*
[]< The stratifier criteria for the measure report, specified as either the name of a valid CQL expression defined within a referenced library or a valid FHIR Resource Path.; (xsd)stratifier:publishablemeasure.group.stratifier>*🔗 A population criteria for the measure.publishablemeasure.group.population(xsd)(doc)=
<#base:Measure.group.population>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< An identifier that is unique within the Measure allowing linkage to the equivalent population in a MeasureReport resource. This ''can'' be a meaningful identifier (e.g. a LOINC code) but is not intended to have any meaning. GUIDs or sequential numbers are appropriate here.
LinkIds can have whitespaces and slashes by design. Tooling should not rely on linkIds being valid XHTML element IDs, and should not directly embed them as such; (xsd)linkId:string>?
< The type of population criteria. Binding: measure-population (extensible, The type of population.); (xsd)code:CodeableConcept>?
< The human readable description of this population criteria.; (xsd)description:markdown>?
< An expression that specifies the criteria for the population, typically the name of an expression in a library. In the case of a continuous-variable or ratio measure, this may be the name of a function that calculates the value of the individual observation for each patient or event in the population. For these types of measures, individual observations are reported as observation resources included in the evaluatedResources bundle for each patient. See the MeasureReport resource or the Quality Reporting topic for more information.; (xsd)criteria:Expression>?
< A Group resource that defines this population as a set of characteristics. Note that this approach can only be used for measures where the basis is of the same type as the populations (e.g. a Patient-based measure, rather than an Encounter-based measure). In addition, the referenced Group resource SHALL be a definitional (as opposed to an actual) group.; (xsd)groupDefinition:Group*>?
< The id of a population element in this measure that provides the input for this population criteria. In most cases, the scoring structure of the measure implies specific relationships (e.g. the Numerator uses the Denominator as the source in a proportion scoring). In some cases, however, multiple possible choices exist and must be resolved explicitly. For example in a ratio measure with multiple initial populations, the denominator must specify which population should be used as the starting point.; (xsd)inputPopulationId:string>?
< Specifies which method should be used to aggregate measure observation values. For most scoring types, this is implied by scoring (e.g. a proportion measure counts members of the populations). For continuous variables, however, this information must be specified to ensure correct calculation. Binding: measure-aggregate-method (extensible, ); (xsd)aggregateMethod:CodeableConcept>?🔗 The stratifier criteria for the measure report, specified as either the name of a valid CQL expression defined within a referenced library or a valid FHIR Resource Path.publishablemeasure.group.stratifier(xsd)(doc)=
<#base:Measure.group.stratifier>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< An identifier that is unique within the Measure allowing linkage to the equivalent item in a MeasureReport resource. This ''can'' be a meaningful identifier (e.g. a LOINC code) but is not intended to have any meaning. GUIDs or sequential numbers are appropriate here.
LinkIds can have whitespaces and slashes by design. Tooling should not rely on linkIds being valid XHTML element IDs, and should not directly embed them as such; (xsd)linkId:string>?
< Indicates a meaning for the stratifier. This can be as simple as a unique identifier, or it can establish meaning in a broader context by drawing from a terminology, allowing stratifiers to be correlated across measures. Binding: measure-stratifier-example (example, Meaning of the stratifier.); (xsd)code:CodeableConcept>?
< The human readable description of this stratifier criteria.; (xsd)description:markdown>?
< An expression that specifies the criteria for the stratifier. This is typically the name of an expression defined within a referenced library, but it may also be a path to a stratifier element.; (xsd)criteria:Expression>?
< A Group resource that defines this population as a set of characteristics. Note that this approach can only be used for measures where the basis is of the same type as the populations (e.g. a Patient-based measure, rather than an Encounter-based measure). In addition, the referenced Group SHALL be a definitional (as opposed to an actual) group.; (xsd)groupDefinition:Group*>?
[]< A component of the stratifier criteria for the measure report, specified as either the name of a valid CQL expression defined within a referenced library or a valid FHIR Resource Path. Stratifiers are defined either as a single criteria, or as a set of component criteria.; (xsd)component:publishablemeasure.group.stratifier.component>*🔗 A component of the stratifier criteria for the measure report, specified as either the name of a valid CQL expression defined within a referenced library or a valid FHIR Resource Path. Stratifiers are defined either as a single criteria, or as a set of component criteria.publishablemeasure.group.stratifier.component(xsd)(doc)=
<#base:Measure.group.stratifier.component>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< An identifier that is unique within the Measure allowing linkage to the equivalent item in a MeasureReport resource. This ''can'' be a meaningful identifier (e.g. a LOINC code) but is not intended to have any meaning. GUIDs or sequential numbers are appropriate here.
LinkIds can have whitespaces and slashes by design. Tooling should not rely on linkIds being valid XHTML element IDs, and should not directly embed them as such; (xsd)linkId:string>?
< Indicates a meaning for the stratifier component. This can be as simple as a unique identifier, or it can establish meaning in a broader context by drawing from a terminology, allowing stratifiers to be correlated across measures. Binding: measure-stratifier-example (example, Meaning of the stratifier.); (xsd)code:CodeableConcept>?
< The human readable description of this stratifier criteria component.; (xsd)description:markdown>?
< An expression that specifies the criteria for this component of the stratifier. This is typically the name of an expression defined within a referenced library, but it may also be a path to a stratifier element.; (xsd)criteria:Expression>?
< A Group resource that defines this population as a set of characteristics. Note that this approach can only be used for measures where the basis is of the same type as the populations (e.g. a Patient-based measure, rather than an Encounter-based measure). In addition, the referenced Group SHALL be a definitional (as opposed to an actual) group.; (xsd)groupDefinition:Group*>?🔗 Related artifacts such as additional documentation, justification, or bibliographic references. Each related artifact is either an attachment, or a reference to another resource, but not both.publishablemeasure.relatedArtifact(xsd)(doc)=
<#base:RelatedArtifact>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< The type of relationship to the related artifact. The presence of both sides of a relationship type (e.g. successor and predecessor) is required to support use cases where one side of a relationship is not represented in FHIR. However, this feature SHALL NOT be used to create bi-directional resource links in FHIR instances. Specifically, following the methodology of "new points to old" and "many points to one", when using related artifact elements to describe and reference FHIR resources, the type element SHALL be drawn from the fhir-related-artifact-type ValueSet. Binding: related-artifact-type (required, The type of relationship to the related artifact.); (xsd)type:code>
[]< Provides additional classifiers of the related artifact. Binding: citation-artifact-classifier (example, Additional classifiers for the related artifact.); (xsd)classifier:CodeableConcept>*
< A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index.; (xsd)label:string>?
< A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.; (xsd)display:string>?
< 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.; (xsd)citation:markdown>?
< The document being referenced, represented as an attachment. This is exclusive with the resource element.; (xsd)document:Attachment>?
< The related artifact, 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.; (xsd)resource:Resource*>?
< The related artifact, if the artifact is not a canonical resource, or a resource reference to a canonical resource. If both resource and resourceReference are present, they SHOULD be consistent and reference the same resource. Although relatedArtifact is intended to support references to definitional resources, there are cases where non-definitional resources can be definitional (such as Location where the kind is mode). Related artifacts SHOULD be used to reference definitional resources, and profiles SHOULD be used to make that explicit for particular use cases.; (xsd)resourceReference:Resource*>?
< The publication status of the artifact being referred to. Binding: publication-status (required, Publication status of an artifact being referred to.); (xsd)publicationStatus:code>?
< The date of publication of the artifact being referred to.; (xsd)publicationDate:date>?🔗 The supplemental data criteria for the measure report, specified as either the name of a valid CQL expression within a referenced library, or a valid FHIR Resource Path. Note that supplemental data are reported as resources for each patient and referenced in the supplementalData element of the MeasureReport. If the supplementalData expression results in a value other than a resource, it is reported using an Observation resource, typically contained in the resulting MeasureReport. See the MeasureReport resource and the Quality Reporting topic for more information.publishablemeasure.supplementalData(xsd)(doc)=
<#base:Measure.supplementalData>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< An identifier that is unique within the Measure allowing linkage to the equivalent item in a MeasureReport resource. This ''can'' be a meaningful identifier (e.g. a LOINC code) but is not intended to have any meaning. GUIDs or sequential numbers are appropriate here.
LinkIds can have whitespaces and slashes by design. Tooling should not rely on linkIds being valid XHTML element IDs, and should not directly embed them as such; (xsd)linkId:string>?
< Indicates a meaning for the supplemental data. This can be as simple as a unique identifier, or it can establish meaning in a broader context by drawing from a terminology, allowing supplemental data to be correlated across measures. Binding: measure-supplemental-data-example (example, Meaning of the supplemental data.); (xsd)code:CodeableConcept>?
[]< An indicator of the intended usage for the supplemental data element. Supplemental data indicates the data is additional information requested to augment the measure information. Risk adjustment factor indicates the data is additional information used to calculate risk adjustment factors when applying a risk model to the measure calculation. Binding: measure-data-usage (extensible, The intended usage for supplemental data elements in the measure.); (xsd)usage:CodeableConcept>*
< The human readable description of this supplemental data.; (xsd)description:markdown>?
< The criteria for the supplemental data. This is typically the name of a valid expression defined within a referenced library, but it may also be a path to a specific data element. The criteria defines the data to be returned for this element.; (xsd)criteria:Expression>🔗 Provides a description of an individual term used within the measure.publishablemeasure.term(xsd)(doc)=
<#base:Measure.term>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A codeable representation of the defined term. Binding: measure-definition-example (example, Codeable representations of measure definition terms.); (xsd)code:CodeableConcept>?
< Provides a definition for the term as used within the measure.; (xsd)definition:markdown>?🔗 A curated namespace that issues unique symbols within that namespace for the identification of concepts, people, devices, etc. Represents a "System" used within the Identifier and Coding data types.publishablenamingsystem(xsd)(doc)=
<#base:shareablenamingsystem>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< An Extension; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< An absolute URI that is used to identify this naming system when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this naming system is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the naming system is stored on different servers. Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.
The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions).
In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.; (xsd)url:uri>
[]< A formal identifier that is used to identify this naming system when it is represented in other formats, or referenced in a specification, model, design or an instance. Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this naming system outside of FHIR, where it is not possible to use the logical URI.; (xsd)identifier:Identifier>*
< The identifier that is used to identify this version of the naming system when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the naming system author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. There may be different naming system instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the naming system with the format [url]|[version]. The version SHOULD NOT contain a '#' - see [Business Version](resource.html#bv-format).; (xsd)version:string>
< Indicates the mechanism used to compare versions to determine which NamingSystem is more current. If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined. Binding: version-algorithm (extensible, ); (xsd)versionAlgorithm:(<Coding>
|<string>)>?
< A natural language name identifying the naming system. This name should be usable as an identifier for the module by machine processing applications such as code generation. The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.The"symbolic name" for an OID would be captured as an extension.; (xsd)name:string>
< A short, descriptive, user-friendly title for the naming system. This title does not need to be machine-processing friendly and may contain punctuation, white-space, etc.; (xsd)title:string>
< The status of this naming system. Enables tracking the life-cycle of the content. Allows filtering of naming systems that are appropriate for use versus not.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization). Binding: publication-status (required, The lifecycle status of an artifact.); (xsd)status:code>
< Indicates the purpose for the naming system - what kinds of things does it make unique? Binding: namingsystem-type (required, Identifies the purpose of the naming system.); (xsd)kind:code>
< A Boolean value to indicate that this naming system is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. Allows filtering of naming systems that are appropriate for use versus not.; (xsd)experimental:boolean>?
< The date (and optionally time) when the naming system was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the naming system changes. The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the naming system. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)date:dateTime>
< The name of the organization or individual responsible for the release and ongoing maintenance of the naming system. Usually an organization but may be an individual. The publisher (or steward) of the naming system is the organization or individual primarily responsible for the maintenance and upkeep of the naming system. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the naming system. This item SHOULD be populated unless the information is available from context.; (xsd)publisher:string>?
[]< Contact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)contact:ContactDetail>*
< The name of the organization that is responsible for issuing identifiers or codes for this namespace and ensuring their non-collision. This is the primary organization. Responsibility for some aspects of a namespace may be delegated.; (xsd)responsible:string>?
< Categorizes a naming system for easier search by grouping related naming systems. This will most commonly be used for identifier namespaces, but categories could potentially be useful for code systems and authorities as well. Binding: namingsystem-identifier-system-type (preferred, A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.); (xsd)type:CodeableConcept>?
< A free text natural language description of the naming system from a consumer's perspective. Details about what the namespace identifies including scope, granularity, version labeling, etc. This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the naming system as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the naming system is presumed to be the predominant language in the place the naming system was created).; (xsd)description:markdown>
[]< The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate naming system instances. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.; (xsd)useContext:UsageContext>*
[]< A legal or geographic region in which the naming system is intended to be used. It may be possible for the naming system to be used in jurisdictions other than those for which it was originally designed or intended.
DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.) Binding: jurisdiction (extensible, Countries and regions within which this artifact is targeted for use.); (xsd)jurisdiction:CodeableConcept>*
< Explanation of why this naming system is needed and why it has been designed as it has. This element does not describe the usage of the code system. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this code system.; (xsd)purpose:markdown>?
< A copyright statement relating to the naming system and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the naming system.; (xsd)copyright:markdown>?
< A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved'). The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.; (xsd)copyrightLabel:string>?
< The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)approvalDate:date>?
< The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. If specified, this date follows the original approval date.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)lastReviewDate:date>?
< The period during which the NamingSystem content was or is planned to be in active use. The effective period for a NamingSystem determines when the content is applicable for usage and is independent of publication and review dates. For example, a NamingSystem intended to be used for the year 2016 might be published in 2015.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)effectivePeriod:Period>?
[]< Descriptions related to the content of the NamingSystem. Topics provide a high-level categorization as well as keywords for the NamingSystem that can be useful for filtering and searching. DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'topic' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#topic and useContext.valueCodeableConcept indicating the topic) Binding: definition-topic (example, ); (xsd)topic:CodeableConcept>*
[]< An individiual or organization primarily involved in the creation and maintenance of the NamingSystem.; (xsd)author:ContactDetail>*
[]< An individual or organization primarily responsible for internal coherence of the NamingSystem.; (xsd)editor:ContactDetail>*
[]< An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the NamingSystem. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)reviewer:ContactDetail>*
[]< An individual or organization asserted by the publisher to be responsible for officially endorsing the NamingSystem for use in some setting. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)endorser:ContactDetail>*
[]< Related artifacts such as additional documentation, justification, dependencies, bibliographic references, and predecessor and successor artifacts. Each related artifact is either an attachment, or a reference to another resource, but not both.; (xsd)relatedArtifact:RelatedArtifact>*
< Provides guidance on the use of the namespace, including the handling of formatting characters, use of upper vs. lower case, etc.; (xsd)usage:string>?
[]< Indicates how the system may be identified when referenced in electronic exchange. Multiple identifiers may exist, either due to duplicate registration, regional rules, needs of different communication technologies, etc.; (xsd)uniqueId:publishablenamingsystem.uniqueId>+
[]< Defines a knowledge representation level provided by this knowledge artifact.; (xsd)knowledgeRepresentationLevel:Extension>*🔗 Indicates how the system may be identified when referenced in electronic exchange. Multiple identifiers may exist, either due to duplicate registration, regional rules, needs of different communication technologies, etc.publishablenamingsystem.uniqueId(xsd)(doc)=
<#base:NamingSystem.uniqueId>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Identifies the unique identifier scheme used for this particular identifier. Different identifier types may be used in different types of communications (OIDs for v3, URIs for FHIR, etc.). Other includes RUIDs from v3, standard v2 code name strings, etc. Preferred identifiers for the same identifier type SHOULD NOT overlap by period. Binding: namingsystem-identifier-type (required, Identifies the style of unique identifier used to identify a namespace.); (xsd)type:code>
< The string that should be sent over the wire to identify the code system or identifier system. If the value is a URI intended for use as FHIR system identifier, the URI should not contain "\" or "?" or "," since this makes escaping very difficult.; (xsd)value:string>
< Indicates whether this identifier is the "preferred" identifier of this type.; (xsd)preferred:boolean>?
< Notes about the past or intended usage of this identifier. e.g. "must be used in Germany" or "was initially published in error with this value".; (xsd)comment:string>?
< Identifies the period of time over which this identifier is considered appropriate to refer to the naming system. Outside of this window, the identifier might be non-deterministic. Within a registry, a given identifier should only be "active" for a single namespace at a time. (Ideally, an identifier should only ever be associated with a single namespace across all time).
The nuance of identifier deprecation is not represented with a separate element. When a determination is made that an identifier should not be used, the validity period end date is updated with the date the identifier is deemed to be deprecated. The identifier should no longer be used once the period end date is reached.; (xsd)period:Period>?
< Indicates whether this identifier ie endorsed by the official owner of the associated naming system.; (xsd)authoritative:boolean>?🔗 This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical and non-clinical artifacts such as clinical decision support rules, order sets, protocols, and drug quality specifications.publishableplandefinition(xsd)(doc)=
<#base:shareableplandefinition>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< An Extension; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< An absolute URI that is used to identify this plan definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this plan definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the plan definition is stored on different servers. Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.
The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions).
In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.; (xsd)url:uri>
[]< A formal identifier that is used to identify this plan definition when it is represented in other formats, or referenced in a specification, model, design or an instance. Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this plan definition outside of FHIR, where it is not possible to use the logical URI.; (xsd)identifier:Identifier>*
< The identifier that is used to identify this version of the plan definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the plan definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts. There may be different plan definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the plan definition with the format [url]|[version]. The version SHOULD NOT contain a '#' - see [Business Version](resource.html#bv-format).; (xsd)version:string>
< Indicates the mechanism used to compare versions to determine which is more current. If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined. Binding: version-algorithm (extensible, ); (xsd)versionAlgorithm:(<Coding>
|<string>)>?
< A natural language name identifying the plan definition. This name should be usable as an identifier for the module by machine processing applications such as code generation. The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.; (xsd)name:string>?
< A short, descriptive, user-friendly title for the plan definition. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.; (xsd)title:string>
< An explanatory or alternate title for the plan definition giving additional information about its content.; (xsd)subtitle:string>?
< A high-level category for the plan definition that distinguishes the kinds of systems that would be interested in the plan definition. Binding: plan-definition-type (extensible, The type of PlanDefinition.); (xsd)type:CodeableConcept>?
< The status of this plan definition. Enables tracking the life-cycle of the content. Allows filtering of plan definitions that are appropriate for use versus not.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization). Binding: publication-status (required, The lifecycle status of an artifact.); (xsd)status:code>
< A Boolean value to indicate that this plan definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. Allows filtering of plan definitions that are appropriate for use versus not.; (xsd)experimental:boolean>?
< A code, group definition, or canonical reference that describes or identifies the intended subject of the plan definition. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource. Note that the choice of canonical for the subject element was introduced in R4B to support pharmaceutical quality use cases. To ensure as much backwards-compatibility as possible, it is recommended to only use the new canonical type with these use cases. Binding: participant-resource-types (extensible, The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).); (xsd)subject:(<AdministrableProductDefinition>
|<CodeableConcept>
|<EvidenceVariable>
|<Group>
|<ManufacturedItemDefinition>
|<MedicinalProductDefinition>
|<PackagedProductDefinition>
|<SubstanceDefinition>)>?
< The date (and optionally time) when the plan definition was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the plan definition changes. The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the plan definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)date:dateTime>
< The name of the organization or individual responsible for the release and ongoing maintenance of the plan definition. Usually an organization but may be an individual. The publisher (or steward) of the plan definition is the organization or individual primarily responsible for the maintenance and upkeep of the plan definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the plan definition. This item SHOULD be populated unless the information is available from context.; (xsd)publisher:string>?
[]< Contact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)contact:ContactDetail>*
< A free text natural language description of the plan definition from a consumer's perspective. This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the plan definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the plan definition is presumed to be the predominant language in the place the plan definition was created).; (xsd)description:markdown>
[]< The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate plan definition instances. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.; (xsd)useContext:UsageContext>*
[]< A legal or geographic region in which the plan definition is intended to be used. It may be possible for the plan definition to be used in jurisdictions other than those for which it was originally designed or intended.
DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.) Binding: jurisdiction (extensible, Countries and regions within which this artifact is targeted for use.); (xsd)jurisdiction:CodeableConcept>*
< Explanation of why this plan definition is needed and why it has been designed as it has. This element does not describe the usage of the plan definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this plan definition.; (xsd)purpose:markdown>?
< A detailed description of how the plan definition is used from a clinical perspective.; (xsd)usage:markdown>?
< A copyright statement relating to the plan definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the plan definition. The short copyright declaration (e.g. (c) '2015+ xyz organization' should be sent in the copyrightLabel element.; (xsd)copyright:markdown>?
< A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved'). The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.; (xsd)copyrightLabel:string>?
< The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)approvalDate:date>?
< The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. If specified, this date follows the original approval date.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)lastReviewDate:date>?
< The period during which the plan definition content was or is planned to be in active use. The effective period for a plan definition determines when the content is applicable for usage and is independent of publication and review dates. For example, a plan definition intended to be used for the year 2016 might be published in 2015.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)effectivePeriod:Period>?
[]< Descriptive topics related to the content of the plan definition. Topics provide a high-level categorization of the definition that can be useful for filtering and searching. DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'topic' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#topic and useContext.valueCodeableConcept indicating the topic) Binding: definition-topic (example, High-level categorization of the definition, used for searching, sorting, and filtering.); (xsd)topic:CodeableConcept>*
[]< An individiual or organization primarily involved in the creation and maintenance of the content.; (xsd)author:ContactDetail>*
[]< An individual or organization primarily responsible for internal coherence of the content.; (xsd)editor:ContactDetail>*
[]< An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the content. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)reviewer:ContactDetail>*
[]< An individual or organization asserted by the publisher to be responsible for officially endorsing the content for use in some setting. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)endorser:ContactDetail>*
[]< Related artifacts such as additional documentation, justification, or bibliographic references. Each related artifact is either an attachment, or a reference to another resource, but not both.; (xsd)relatedArtifact:publishableplandefinition.relatedArtifact>*
[]< A reference to a Library resource containing any formal logic used by the plan definition.; (xsd)library:Library*>*
[]< A goal describes an expected outcome that activities within the plan are intended to achieve. For example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, meeting the acceptance criteria for a test as specified by a quality specification, etc.; (xsd)goal:publishableplandefinition.goal>*
[]< Actors represent the individuals or groups involved in the execution of the defined set of activities.; (xsd)actor:publishableplandefinition.actor>*
[]< An action or group of actions to be taken as part of the plan. For example, in clinical care, an action would be to prescribe a particular indicated medication, or perform a particular test as appropriate. In pharmaceutical quality, an action would be the test that needs to be performed on a drug product as defined in the quality specification. Note that there is overlap between many of the elements defined here and the ActivityDefinition resource. When an ActivityDefinition is referenced (using the definition element), the overlapping elements in the plan override the content of the referenced ActivityDefinition unless otherwise documented in the specific elements. See the PlanDefinition resource for more detailed information.; (xsd)action:publishableplandefinition.action>*
< If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example "pain", "on flare-up", etc. Binding: medication-as-needed-reason (example, A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc.); (xsd)asNeeded:(<boolean>
|<CodeableConcept>)>?
[]< Defines a knowledge capability afforded by this knowledge artifact.; (xsd)knowledgeCapability:Extension>*
[]< Defines a knowledge representation level provided by this knowledge artifact.; (xsd)knowledgeRepresentationLevel:Extension>*
[]< A comment containing additional documentation, a review comment, usage guidance, or other relevant information from a particular user.; (xsd)artifactComment:Extension>*🔗 An action or group of actions to be taken as part of the plan. For example, in clinical care, an action would be to prescribe a particular indicated medication, or perform a particular test as appropriate. In pharmaceutical quality, an action would be the test that needs to be performed on a drug product as defined in the quality specification. Note that there is overlap between many of the elements defined here and the ActivityDefinition resource. When an ActivityDefinition is referenced (using the definition element), the overlapping elements in the plan override the content of the referenced ActivityDefinition unless otherwise documented in the specific elements. See the PlanDefinition resource for more detailed information.publishableplandefinition.action(xsd)(doc)=
<#base:PlanDefinition.action>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< An identifier that is unique within the PlanDefinition to allow linkage within the realized CarePlan and/or RequestOrchestration.; (xsd)linkId:string>?
< A user-visible prefix for the action. For example a section or item numbering such as 1. or A.; (xsd)prefix:string>?
< The textual description of the action displayed to a user. For example, when the action is a test to be performed, the title would be the title of the test such as Assay by HPLC.; (xsd)title:string>?
< A brief description of the action used to provide a summary to display to the user.; (xsd)description:markdown>?
< A text equivalent of the action to be performed. This provides a human-interpretable description of the action when the definition is consumed by a system that might not be capable of interpreting it dynamically.; (xsd)textEquivalent:markdown>?
< Indicates how quickly the action should be addressed with respect to other actions. Binding: request-priority (required, Identifies the level of importance to be assigned to actioning the request.); (xsd)priority:code>?
< A code that provides a meaning, grouping, or classification for the action or action group. For example, a section may have a LOINC code for the section of a documentation template. In pharmaceutical quality, an action (Test) such as pH could be classified as a physical property. Binding: action-code (example, Provides examples of actions to be performed.); (xsd)code:CodeableConcept>?
[]< A description of why this action is necessary or appropriate. This is different than the clinical evidence documentation, it's an actual business description of the reason for performing the action. Binding: action-reason-code (example, Provides examples of reasons for actions to be performed.); (xsd)reason:CodeableConcept>*
[]< Didactic or other informational resources associated with the action that can be provided to the CDS recipient. Information resources can include inline text commentary and links to web resources.; (xsd)documentation:RelatedArtifact>*
[]< Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition. In pharmaceutical quality, a goal represents acceptance criteria (Goal) for a given action (Test), so the goalId would be the unique id of a defined goal element establishing the acceptance criteria for the action.; (xsd)goalId:id>*
< A code, group definition, or canonical reference that describes the intended subject of the action and its children, if any. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource. The subject of an action overrides the subject at a parent action or on the root of the PlanDefinition if specified.
In addition, because the subject needs to be resolved during realization, use of subjects in actions (or in the ActivityDefinition referenced by the action) resolves based on the set of subjects supplied in context and by type (i.e. the patient subject would resolve to a resource of type Patient). Binding: participant-resource-types (extensible, The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).); (xsd)subject:(<CodeableConcept>
|<Group>
|<Resource>)>?
[]< A description of when the action should be triggered. When multiple triggers are specified on an action, any triggering event invokes the action.; (xsd)trigger:TriggerDefinition>*
[]< An expression that describes applicability criteria or start/stop conditions for the action. When multiple conditions of the same kind are present, the effects are combined using AND semantics, so the overall condition is true only if all the conditions are true.; (xsd)condition:publishableplandefinition.action.condition>*
[]< Defines input data requirements for the action.; (xsd)input:publishableplandefinition.action.input>*
[]< Defines the outputs of the action, if any.; (xsd)output:publishableplandefinition.action.output>*
[]< A relationship to another action such as "before" or "30-60 minutes after start of". When an action depends on multiple actions, the meaning is that all actions are dependencies, rather than that any of the actions are a dependency.; (xsd)relatedAction:publishableplandefinition.action.relatedAction>*
< An optional value describing when the action should be performed. The intent of the timing element is to provide timing when the action should be performed. As a definitional resource, this timing is interpreted as part of an apply operation so that the timing of the result actions in a CarePlan or RequestOrchestration, for example, would be specified by evaluating the timing definition in the context of the apply and setting the resulting timing on the appropriate elements of the target resource. If the timing is an Age, the activity is expected to be performed when the subject is the given Age. When the timing is a Duration, the activity is expected to be performed within the specified duration from the apply. When the timing is a Range, it may be a range of Ages or Durations, providing a range for the expected timing of the resulting activity. When the timing is a Timing, it is establishing a schedule for the timing of the resulting activity.; (xsd)timing:(<Age>
|<Duration>
|<Range>
|<Timing>)>?
< Identifies the facility where the action will occur; e.g. home, hospital, specific clinic, etc. May reference a specific clinical location or may just identify a type of location.; (xsd)location:Location*>?
[]< Indicates who should participate in performing the action described.; (xsd)participant:publishableplandefinition.action.participant>*
< The type of action to perform (create, update, remove). Binding: action-type (extensible, The type of action to be performed.); (xsd)type:CodeableConcept>?
< Defines the grouping behavior for the action and its children. Binding: action-grouping-behavior (required, Defines organization behavior of a group.); (xsd)groupingBehavior:code>?
< Defines the selection behavior for the action and its children. Binding: action-selection-behavior (required, Defines selection behavior of a group.); (xsd)selectionBehavior:code>?
< Defines the required behavior for the action. Binding: action-required-behavior (required, Defines expectations around whether an action or action group is required.); (xsd)requiredBehavior:code>?
< Defines whether the action should usually be preselected. Binding: action-precheck-behavior (required, Defines selection frequency behavior for an action or group.); (xsd)precheckBehavior:code>?
< Defines whether the action can be selected multiple times. Binding: action-cardinality-behavior (required, Defines behavior for an action or a group for how many times that item may be repeated.); (xsd)cardinalityBehavior:code>?
< A reference to an ActivityDefinition that describes the action to be taken in detail, a MessageDefinition describing a message to be snet, a PlanDefinition that describes a series of actions to be taken, a Questionnaire that should be filled out, a SpecimenDefinition describing a specimen to be collected, or an ObservationDefinition that specifies what observation should be captured. Note that the definition is optional, and if no definition is specified, a dynamicValue with a root ($this) path can be used to define the entire resource dynamically.; (xsd)definition:(<ActivityDefinition>
|<MessageDefinition>
|<ObservationDefinition>
|<PlanDefinition>
|<Questionnaire>
|<SpecimenDefinition>
|<uri>)>?
< A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input. Note that when a referenced ActivityDefinition also defines a transform, the transform specified here generally takes precedence. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.; (xsd)transform:StructureMap*>?
[]< Customizations that should be applied to the statically defined resource. For example, if the dosage of a medication must be computed based on the patient's weight, a customization would be used to specify an expression that calculated the weight, and the path on the resource that would contain the result. Dynamic values are applied in the order in which they are defined in the PlanDefinition resource. Note that when dynamic values are also specified by a referenced ActivityDefinition, the dynamicValues from the ActivityDefinition are applied first, followed by the dynamicValues specified here. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.; (xsd)dynamicValue:publishableplandefinition.action.dynamicValue>*
[]< Sub actions that are contained within the action. The behavior of this action determines the functionality of the sub-actions. For example, a selection behavior of at-most-one indicates that of the sub-actions, at most one may be chosen as part of realizing the action definition.; (xsd)action:PlanDefinition.action>*🔗 An expression that describes applicability criteria or start/stop conditions for the action. When multiple conditions of the same kind are present, the effects are combined using AND semantics, so the overall condition is true only if all the conditions are true.publishableplandefinition.action.condition(xsd)(doc)=
<#base:PlanDefinition.action.condition>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The kind of condition. Applicability criteria are used to determine immediate applicability when a plan definition is applied to a given context. Start and stop criteria are carried through application and used to describe enter/exit criteria for an action. Binding: action-condition-kind (required, Defines the kinds of conditions that can appear on actions.); (xsd)kind:code>
< An expression that returns true or false, indicating whether the condition is satisfied. The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.; (xsd)expression:Expression>?🔗 Customizations that should be applied to the statically defined resource. For example, if the dosage of a medication must be computed based on the patient's weight, a customization would be used to specify an expression that calculated the weight, and the path on the resource that would contain the result. Dynamic values are applied in the order in which they are defined in the PlanDefinition resource. Note that when dynamic values are also specified by a referenced ActivityDefinition, the dynamicValues from the ActivityDefinition are applied first, followed by the dynamicValues specified here. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.publishableplandefinition.action.dynamicValue(xsd)(doc)=
<#base:PlanDefinition.action.dynamicValue>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The path to the element to be customized. This is the path on the resource that will hold the result of the calculation defined by the expression. The specified path SHALL be a FHIRPath resolvable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. 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). To specify the path to the current action being realized, the %action environment variable is available in this path. For example, to specify the description element of the target action, the path would be %action.description. The path attribute contains a [Simple FHIRPath Subset](fhirpath.html#simple) that allows path traversal, but not calculation.; (xsd)path:string>?
< An expression specifying the value of the customized element. The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.; (xsd)expression:Expression>?🔗 Defines input data requirements for the action.publishableplandefinition.action.input(xsd)(doc)=
<#base:PlanDefinition.action.input>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A human-readable label for the data requirement used to label data flows in BPMN or similar diagrams. Also provides a human readable label when rendering the data requirement that conveys its purpose to human readers.; (xsd)title:string>?
< Defines the data that is to be provided as input to the action.; (xsd)requirement:DataRequirement>?
< Points to an existing input or output element that provides data to this input. The relatedData element allows indicating that an input to a parent action is an input to specific child actions. It also allows the output of one action to be identified as the input to a different action; (xsd)relatedData:id>?🔗 Defines the outputs of the action, if any.publishableplandefinition.action.output(xsd)(doc)=
<#base:PlanDefinition.action.output>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A human-readable label for the data requirement used to label data flows in BPMN or similar diagrams. Also provides a human readable label when rendering the data requirement that conveys its purpose to human readers.; (xsd)title:string>?
< Defines the data that results as output from the action.; (xsd)requirement:DataRequirement>?
< Points to an existing input or output element that is results as output from the action. The relatedData element allows indicating that the output of child action is also the output of a parent action. It also allows the input of one action to be identified as the output of a different action; (xsd)relatedData:string>?🔗 Indicates who should participate in performing the action described.publishableplandefinition.action.participant(xsd)(doc)=
<#base:PlanDefinition.action.participant>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A reference to the id element of the actor who will participate in this action.; (xsd)actorId:string>?
< The type of participant in the action. Binding: action-participant-type (required, The type of participant in the activity.); (xsd)type:code>?
< The type of participant in the action.; (xsd)typeCanonical:CapabilityStatement*>?
< The type of participant in the action. When this element is a reference, it SHOULD be a reference to a definitional resource (for example, a location type, rather than a specific location).; (xsd)typeReference:(<CareTeam>
|<Device>
|<DeviceDefinition>
|<Endpoint>
|<Group>
|<HealthcareService>
|<Location>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>?
< The role the participant should play in performing the described action. Binding: http://terminology.hl7.org/ValueSet/action-participant-role (example, Defines roles played by participants for the action.); (xsd)role:CodeableConcept>?
< Indicates how the actor will be involved in the action - author, reviewer, witness, etc. Binding: action-participant-function (example, ); (xsd)function:CodeableConcept>?🔗 A relationship to another action such as "before" or "30-60 minutes after start of". When an action depends on multiple actions, the meaning is that all actions are dependencies, rather than that any of the actions are a dependency.publishableplandefinition.action.relatedAction(xsd)(doc)=
<#base:PlanDefinition.action.relatedAction>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The element id of the target related action.; (xsd)targetId:id>
< The relationship of the start of this action to the related action. Binding: action-relationship-type (required, Defines the types of relationships between actions.); (xsd)relationship:code>
< The relationship of the end of this action to the related action. Binding: action-relationship-type (required, Defines the types of relationships between actions.); (xsd)endRelationship:code>?
< A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.; (xsd)offset:(<Duration>
|<Range>)>?🔗 Actors represent the individuals or groups involved in the execution of the defined set of activities.publishableplandefinition.actor(xsd)(doc)=
<#base:PlanDefinition.actor>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A descriptive label for the actor.; (xsd)title:string>?
< A description of how the actor fits into the overall actions of the plan definition.; (xsd)description:markdown>?
[]< The characteristics of the candidates that could serve as the actor.; (xsd)option:publishableplandefinition.actor.option>+🔗 The characteristics of the candidates that could serve as the actor.publishableplandefinition.actor.option(xsd)(doc)=
<#base:PlanDefinition.actor.option>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The type of participant in the action. Binding: action-participant-type (required, The type of participant in the activity.); (xsd)type:code>?
< The type of participant in the action.; (xsd)typeCanonical:CapabilityStatement*>?
< The type of participant in the action. When this element is a reference, it SHOULD be a reference to a definitional resource (for example, a location type, rather than a specific location).; (xsd)typeReference:(<CareTeam>
|<Device>
|<DeviceDefinition>
|<Endpoint>
|<Group>
|<HealthcareService>
|<Location>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>?
< The role the participant should play in performing the described action. Binding: http://terminology.hl7.org/ValueSet/action-participant-role (example, ); (xsd)role:CodeableConcept>?🔗 A goal describes an expected outcome that activities within the plan are intended to achieve. For example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, meeting the acceptance criteria for a test as specified by a quality specification, etc.publishableplandefinition.goal(xsd)(doc)=
<#base:PlanDefinition.goal>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Indicates a category the goal falls within. Binding: goal-category (example, Example codes for grouping goals for filtering or presentation.); (xsd)category:CodeableConcept>?
< Human-readable and/or coded description of a specific desired objective of care, such as "control blood pressure" or "negotiate an obstacle course" or "dance with child at wedding". If no code is available, use CodeableConcept.text. Binding: clinical-findings (example, Describes goals that can be achieved.); (xsd)description:CodeableConcept>
< Identifies the expected level of importance associated with reaching/sustaining the defined goal. Binding: goal-priority (preferred, Indicates the level of importance associated with reaching or sustaining a goal.); (xsd)priority:CodeableConcept>?
< The event after which the goal should begin being pursued. Binding: goal-start-event (example, Identifies the types of events that might trigger the start of a goal.); (xsd)start:CodeableConcept>?
[]< Identifies problems, conditions, issues, or concerns the goal is intended to address. Binding: condition-code (example, Identifies problems, conditions, issues, or concerns that goals may address.); (xsd)addresses:CodeableConcept>*
[]< Didactic or other informational resources associated with the goal that provide further supporting information about the goal. Information resources can include inline text commentary and links to web resources.; (xsd)documentation:RelatedArtifact>*
[]< Indicates what should be done and within what timeframe.; (xsd)target:publishableplandefinition.goal.target>*🔗 Indicates what should be done and within what timeframe.publishableplandefinition.goal.target(xsd)(doc)=
<#base:PlanDefinition.goal.target>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The parameter whose value is to be tracked, e.g. body weight, blood pressure, or hemoglobin A1c level. Binding: observation-codes (example, Identifies types of parameters that can be tracked to determine goal achievement.); (xsd)measure:CodeableConcept>?
< The target value of the measure to be achieved to signify fulfillment of the goal, e.g. 150 pounds or 7.0%, or in the case of pharmaceutical quality - NMT 0.6%, Clear solution, etc. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any value at or above the low value. A CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the goal.target.measure defines a coded value.; (xsd)detail:(<boolean>
|<CodeableConcept>
|<integer>
|<Quantity>
|<Range>
|<Ratio>
|<string>)>?
< Indicates the timeframe after the start of the goal in which the goal should be met.; (xsd)due:Duration>?🔗 Related artifacts such as additional documentation, justification, or bibliographic references. Each related artifact is either an attachment, or a reference to another resource, but not both.publishableplandefinition.relatedArtifact(xsd)(doc)=
<#base:RelatedArtifact>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< The type of relationship to the related artifact. The presence of both sides of a relationship type (e.g. successor and predecessor) is required to support use cases where one side of a relationship is not represented in FHIR. However, this feature SHALL NOT be used to create bi-directional resource links in FHIR instances. Specifically, following the methodology of "new points to old" and "many points to one", when using related artifact elements to describe and reference FHIR resources, the type element SHALL be drawn from the fhir-related-artifact-type ValueSet. Binding: related-artifact-type (required, The type of relationship to the related artifact.); (xsd)type:code>
[]< Provides additional classifiers of the related artifact. Binding: citation-artifact-classifier (example, Additional classifiers for the related artifact.); (xsd)classifier:CodeableConcept>*
< A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index.; (xsd)label:string>?
< A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.; (xsd)display:string>?
< 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.; (xsd)citation:markdown>?
< The document being referenced, represented as an attachment. This is exclusive with the resource element.; (xsd)document:Attachment>?
< The related artifact, 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.; (xsd)resource:Resource*>?
< The related artifact, if the artifact is not a canonical resource, or a resource reference to a canonical resource. If both resource and resourceReference are present, they SHOULD be consistent and reference the same resource. Although relatedArtifact is intended to support references to definitional resources, there are cases where non-definitional resources can be definitional (such as Location where the kind is mode). Related artifacts SHOULD be used to reference definitional resources, and profiles SHOULD be used to make that explicit for particular use cases.; (xsd)resourceReference:Resource*>?
< The publication status of the artifact being referred to. Binding: publication-status (required, Publication status of an artifact being referred to.); (xsd)publicationStatus:code>?
< The date of publication of the artifact being referred to.; (xsd)publicationDate:date>?🔗 A ValueSet resource instance specifies a set of codes drawn from one or more code systems, intended for use in a particular context. Value sets link between [CodeSystem](codesystem.html) definitions and their use in [coded elements](terminologies.html).publishablevalueset(xsd)(doc)=
<#base:shareablevalueset>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< An Extension; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< An absolute URI that is used to identify this value set when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this value set is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the value set is stored on different servers. Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.
The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions).
In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.; (xsd)url:uri>
[]< A formal identifier that is used to identify this value set when it is represented in other formats, or referenced in a specification, model, design or an instance. Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this value set outside of FHIR, where it is not possible to use the logical URI.; (xsd)identifier:Identifier>*
< The identifier that is used to identify this version of the value set when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the value set author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. There may be different value set instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the value set with the format [url]|[version]. The version SHOULD NOT contain a '#' - see [Business Version](resource.html#bv-format).; (xsd)version:string>
< Indicates the mechanism used to compare versions to determine which ValueSet is more current. If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined. Binding: version-algorithm (extensible, ); (xsd)versionAlgorithm:(<Coding>
|<string>)>?
< A natural language name identifying the value set. This name should be usable as an identifier for the module by machine processing applications such as code generation. The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.A name should be provided unless the value set is a contained resource (e.g. an anonymous value set in a profile). Most registries will require a name.; (xsd)name:string>?
< A short, descriptive, user-friendly title for the value set. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.; (xsd)title:string>
< The status of this value set. Enables tracking the life-cycle of the content. The status of the value set applies to the value set definition (ValueSet.compose) and the associated ValueSet metadata. Expansions do not have a state. Allows filtering of value sets that are appropriate for use versus not.See also the [http://hl7.org/fhir/StructureDefinition/valueset-workflowStatusDescription](http://hl7.org/fhir/extensions/StructureDefinition-valueset-workflowStatusDescription.html) extension for additional status information related to the editorial process.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization). Binding: publication-status (required, The lifecycle status of an artifact.); (xsd)status:code>
< A Boolean value to indicate that this value set is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. Allows filtering of value sets that are appropriate for use versus not.; (xsd)experimental:boolean>
< The date (and optionally time) when the value set metadata or content logical definition (.compose) was created or revised. Note that this is not the same as the meta.lastUpdated which is specific to an instance of a value set resource on a server. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)date:dateTime>
< The name of the organization or individual responsible for the release and ongoing maintenance of the value set. Usually an organization but may be an individual. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the value set. This item SHOULD be populated unless the information is available from context.; (xsd)publisher:string>?
[]< Contact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)contact:ContactDetail>*
< A free text natural language description of the value set from a consumer's perspective. The textual description specifies the span of meanings for concepts to be included within the Value Set Expansion, and also may specify the intended use and limitations of the Value Set. Description SHOULD contain instructions for clinical or administrative use and interpretation and information about misuse. Description SHOULD be populated unless the information is available from context. Description SHOULD be populated unless the value set is a contained resource (e.g. a value set defined solely in the context of a profile).; (xsd)description:markdown>
[]< The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate value set instances. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.; (xsd)useContext:UsageContext>*
[]< A legal or geographic region in which the value set is intended to be used. It may be possible for the value set to be used in jurisdictions other than those for which it was originally designed or intended.
DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.) Binding: jurisdiction (extensible, Countries and regions within which this artifact is targeted for use.); (xsd)jurisdiction:CodeableConcept>*
< If this is set to 'true', then no new versions of the content logical definition can be created. Note: Other metadata might still change. Normally immutability is set to 'false', which is the default assumption if it is not populated. Note that the implication is that if this is set to 'true', there may be only one ValueSet version for this definition. Immutability tends to be set to 'true' in one of two cases: - Where the value set, by the nature of its usage, cannot change. For example "All specializations of ACT in ActClassCode" - Where there's no safe way to express the "Purpose" such that someone else could safely make changes to the value set definition. Source workflow control must guarantee that the same URI always yields the same definition.; (xsd)immutable:boolean>?
< Explanation of why this value set is needed and why it has been designed as it has. This element does not describe the usage of the value set. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this value set.; (xsd)purpose:markdown>?
< A copyright statement relating to the value set and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the value set. Frequently, the copyright differs between the value set and the codes that are included. The copyright statement should clearly differentiate between these when required.; (xsd)copyright:markdown>?
< A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved'). The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.; (xsd)copyrightLabel:string>?
< The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)approvalDate:date>?
< The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. If specified, this date follows the original approval date.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)lastReviewDate:date>?
< The period during which the ValueSet content was or is planned to be in active use. The effective period for a ValueSet determines when the content is applicable for usage and is independent of publication and review dates. For example, a valueset intended to be used for the year 2016 might be published in 2015.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)effectivePeriod:Period>?
[]< Descriptions related to the content of the ValueSet. Topics provide a high-level categorization as well as keywords for the ValueSet that can be useful for filtering and searching. DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'topic' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#topic and useContext.valueCodeableConcept indicating the topic) Binding: definition-topic (example, ); (xsd)topic:CodeableConcept>*
[]< An individiual or organization primarily involved in the creation and maintenance of the ValueSet.; (xsd)author:ContactDetail>*
[]< An individual or organization primarily responsible for internal coherence of the ValueSet.; (xsd)editor:ContactDetail>*
[]< An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the ValueSet. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)reviewer:ContactDetail>*
[]< An individual or organization asserted by the publisher to be responsible for officially endorsing the ValueSet for use in some setting. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)endorser:ContactDetail>*
[]< Related artifacts such as additional documentation, justification, dependencies, bibliographic references, and predecessor and successor artifacts. Each related artifact is either an attachment, or a reference to another resource, but not both.; (xsd)relatedArtifact:RelatedArtifact>*
< A set of criteria that define the contents of the value set by including or excluding codes selected from the specified code system(s) that the value set draws from. This is also known as the Content Logical Definition (CLD).; (xsd)compose:publishablevalueset.compose>?
< A value set can also be "expanded", where the value set is turned into a simple collection of enumerated codes. This element holds the expansion, if it has been performed. Expansion is performed to produce a collection of codes that are ready to use for data entry or validation. Value set expansions are always considered to be stateless - they are a record of the set of codes in the value set at a point in time under a given set of conditions, and are not subject to ongoing maintenance.
Expansion.parameter is a simplified list of parameters - a subset of the features of the [Parameters](parameters.html) resource.; (xsd)expansion:publishablevalueset.expansion>?
< Description of the semantic space the Value Set Expansion is intended to cover and should further clarify the text in ValueSet.description.; (xsd)scope:publishablevalueset.scope>?
[]< Defines a knowledge representation level provided by this knowledge artifact.; (xsd)knowledgeRepresentationLevel:Extension>*
< A reference to the authoritative accessible, persisted source of truth of the entire Value Set Definition, including textual information and available versions. If this extension is not present, then the canonical URL (ValueSet.url) also serves the purpose of specifying the authoritative source. A difference between the canonical URL and the authoritiative source might arise in some cases due to ongoing organization restructuring, etc., and in those cases this extension may be used. The URL of the authoritative source is intended to be resolvable but that cannot be guaranteed. The designated "authoritative source" is normally expected to be able to generate a valid expansion of the value set, and if for some reason it cannot then the valueset-trusted-expansion should be used.; (xsd)authoritativeSource:Extension>?
< Indicates an authoritative source for performing value set expansions. If the designated "authoritative source" (as specified in the valueset-authoritativeSource extension, if present) is unable to provide a valid expansion, this extension indicates an alternate authoritative source where the value set expansion may be performed. The alternate authoritative source url must reference a FHIR terminology server endpoint (the [base] url of the FHIR server).; (xsd)trustedExpansion:Extension>?
[]< Human readable titles for the valueset.; (xsd)otherTitle:Extension>*
< This text is intended to act as a citation to work done elsewhere that is not part of the current stewarding process where the referenced source is in some way a basis of the current value set definition. This is not intended to be a direct link to another value set. It is only intended to support a link or textual description that indicates related material for the value set.; (xsd)sourceReference:Extension>?🔗 A set of criteria that define the contents of the value set by including or excluding codes selected from the specified code system(s) that the value set draws from. This is also known as the Content Logical Definition (CLD).publishablevalueset.compose(xsd)(doc)=
<#base:ValueSet.compose>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< An Extension; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The Locked Date is the effective date that is used to determine the version of all referenced Code Systems and Value Set Definitions included in the compose that are not already tied to a specific version. With a defined lockedDate the value set is considered "Locked". Otherwise, the value set may have different expansions as underlying code systems and/or value sets evolve. The interpretation of lockedDate is often dependent on the context - e.g. a SNOMED CT derived value set with a lockedDate will have a different expansion in USA than in UK. If a value set specifies a version for include and exclude statements, and also specifies a locked date, the specified versions need to be available that date, or the value set will not be usable.; (xsd)lockedDate:date>?
< Whether inactive codes - codes that are not approved for current use - are in the value set. If inactive = true, inactive codes are to be included in the expansion, if inactive = false, the inactive codes will not be included in the expansion. If absent, the behavior is determined by the implementation, or by the applicable $expand parameters (but generally, inactive codes would be expected to be included). Note that in the FHIR terminology framework, "deprecated" does not mean inactive, but in some code systems, e.g. LOINC, "deprecated" does mean inactive. Code systems should define what codes are considered to be inactive. If this is not clearly defined (including in the FHIR code system resource), then all codes are assumed to be active.
The Value Set Definition specification defines an ActiveOnly element, which is the reverse of this element e.g. (ValueSet.compose.inactive=FALSE) is the same as (VSD.ActiveOnly=TRUE).; (xsd)inactive:boolean>?
[]< Include one or more codes from a code system or other value set(s). All the conditions in an include must be true. If a system is listed, all the codes from the system are listed. If one or more filters are listed, all of the filters must apply. If one or more value sets are listed, the codes must be in all the value sets. E.g. each include is 'include all the codes that meet all these conditions'.; (xsd)include:publishablevalueset.compose.include>+
[]< Exclude one or more codes from the value set based on code system filters and/or other value sets. Usually this is used to selectively exclude codes that were included by subsumption in the inclusions. Any display names specified for the codes are ignored.; (xsd)exclude:ValueSet.compose.include>*
[]< A property to return in the expansion, if the client doesn't ask for any particular properties. May be either a code from the code system definition (convenient) or a the formal URI that refers to the property. The special value '*' means all properties known to the server. Note that property names can clash, so using a URI is recommended.; (xsd)property:string>*
< User who created the compose for the ValueSet.; (xsd)composeCreatedBy:Extension>?
< User who created the compose for the ValueSet.; (xsd)composeCreationDate:Extension>?🔗 Include one or more codes from a code system or other value set(s). All the conditions in an include must be true. If a system is listed, all the codes from the system are listed. If one or more filters are listed, all of the filters must apply. If one or more value sets are listed, the codes must be in all the value sets. E.g. each include is 'include all the codes that meet all these conditions'.publishablevalueset.compose.include(xsd)(doc)=
<#base:ValueSet.compose.include>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< An absolute URI which is the code system from which the selected codes come from. If there are no codes or filters, the entire code system is included. Note that the set of codes that are included may contain abstract codes. See ''Coding.system'' for further documentation about the correct value for the system element.; (xsd)system:uri>?
< The version of the code system that the codes are selected from, or the special version '*' for all versions. This is used when selecting the descendants of a concept - they may change between versions. If no version is specified, then the exact contents of the value set might not be known until a context of use binds it to a particular version. The special value '*' means all versions; It is at server discretion regarding expansions and which versions must be supported.; (xsd)version:string>?
[]< Specifies a concept to be included or excluded. The list of concepts is considered ordered, though the order might not have any particular significance. Typically, the order of an expansion follows that defined in the compose element.; (xsd)concept:publishablevalueset.compose.include.concept>*
[]< Select concepts by specifying a matching criterion based on the properties (including relationships) defined by the system, or on filters defined by the system. If multiple filters are specified within the include, they SHALL all be true. Selecting codes by specifying filters based on properties is only possible where the underlying code system defines appropriate properties. Note that in some cases, the underlying code system defines the logical concepts but not the literal codes for the concepts. In such cases, the literal definitions may be provided by a third party.; (xsd)filter:publishablevalueset.compose.include.filter>*
[]< Selects the concepts found in this value set (based on its value set definition). This is an absolute URI that is a reference to ValueSet.url. If multiple value sets are specified this includes the intersection of the contents of all of the referenced value sets. The value set URI is either a logical reference to a defined value set such as a [SNOMED CT reference set](https://terminology.hl7.org/SNOMEDCT.html), or a direct reference to a value set definition using ValueSet.url. The reference might not refer to an actual FHIR ValueSet resource; in this case, whatever is referred to is an implicit definition of a value set that needs to be clear about how versions are resolved.; (xsd)valueSet:ValueSet*>*
< A copyright statement for the specific code system asserted by the containing ValueSet.compose.include element's system value (if the associated ValueSet.compose.include.version element is not present); or the code system and version combination (if the associated ValueSet.compose.include.version element is present).; (xsd)copyright:string>?🔗 Specifies a concept to be included or excluded. The list of concepts is considered ordered, though the order might not have any particular significance. Typically, the order of an expansion follows that defined in the compose element.publishablevalueset.compose.include.concept(xsd)(doc)=
<#base:ValueSet.compose.include.concept>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Specifies a code for the concept to be included or excluded. Expressions are allowed if defined by the underlying code system.; (xsd)code>
< The text to display to the user for this concept in the context of this valueset. If no display is provided, then applications using the value set use the display specified for the code by the system. The value set resource allows for an alternative display to be specified for when this concept is used in this particular value set. See notes in the value set narrative about the correct use of this element.; (xsd)display:string>?
[]< Additional representations for this concept when used in this value set - other languages, aliases, specialized purposes, used for particular purposes, etc. Concepts have both a ```display``` and an array of ```designation```. The display is equivalent to a special designation with an implied ```designation.use``` of "primary code" and a language equal to the [Resource Language](resource.html#language).; (xsd)designation:publishablevalueset.compose.include.concept.designation>*🔗 Additional representations for this concept when used in this value set - other languages, aliases, specialized purposes, used for particular purposes, etc. Concepts have both a ```display``` and an array of ```designation```. The display is equivalent to a special designation with an implied ```designation.use``` of "primary code" and a language equal to the [Resource Language](resource.html#language).publishablevalueset.compose.include.concept.designation(xsd)(doc)=
<#base:ValueSet.compose.include.concept.designation>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The language this designation is defined for. In the absence of a language, the resource language applies. Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< A code that represents types of uses of designations. If no use is provided, the designation can be assumed to be suitable for general display to a human user. Binding: designation-use (extensible, Details of how a designation would be used.); (xsd)use:Coding>?
[]< Additional codes that detail how this designation would be used, if there is more than one use. This was added rather than increasing the cardinality of .use to 0..* in order to maintain backward compatibility. Binding: designation-use (extensible, Details of how a designation would be used.); (xsd)additionalUse:Coding>*
< The text value for this designation.; (xsd)value:string>🔗 Select concepts by specifying a matching criterion based on the properties (including relationships) defined by the system, or on filters defined by the system. If multiple filters are specified within the include, they SHALL all be true. Selecting codes by specifying filters based on properties is only possible where the underlying code system defines appropriate properties. Note that in some cases, the underlying code system defines the logical concepts but not the literal codes for the concepts. In such cases, the literal definitions may be provided by a third party.publishablevalueset.compose.include.filter(xsd)(doc)=
<#base:ValueSet.compose.include.filter>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A code that identifies a property or a filter defined in the code system.; (xsd)property:code>
< The kind of operation to perform as a part of the filter criteria. In case filter.property represents a property of the system, the operation applies to the selected property. In case filter.property represents a filter of the system, the operation SHALL match one of the CodeSystem.filter.operator values. Binding: filter-operator (required, The kind of operation to perform as a part of a property based filter.); (xsd)op:code>
< The match value may be either a code defined by the system, or a string value, which is a regex match on the literal string of the property value (if the filter represents a property defined in CodeSystem) or of the system filter value (if the filter represents a filter defined in CodeSystem) when the operation is 'regex', or one of the values (true and false), when the operation is 'exists'. Use regex matching with care - full regex matching on every SNOMED CT term is prohibitive, for example.; (xsd)value:string>🔗 A value set can also be "expanded", where the value set is turned into a simple collection of enumerated codes. This element holds the expansion, if it has been performed. Expansion is performed to produce a collection of codes that are ready to use for data entry or validation. Value set expansions are always considered to be stateless - they are a record of the set of codes in the value set at a point in time under a given set of conditions, and are not subject to ongoing maintenance.
Expansion.parameter is a simplified list of parameters - a subset of the features of the [Parameters](parameters.html) resource.publishablevalueset.expansion(xsd)(doc)=
<#base:ValueSet.expansion>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< An identifier that uniquely identifies this expansion of the valueset, based on a unique combination of the provided parameters, the system default parameters, and the underlying system code system versions etc. Systems may re-use the same identifier as long as those factors remain the same, and the expansion is the same, but are not required to do so. This is a business identifier. Typically, this uri is a UUID (e.g. urn:uuid:8230ff20-c97a-4167-a59d-dc2cb9df16dd).; (xsd)identifier:uri>?
< As per paging Search results, the next URLs are opaque to the client, have no dictated structure, and only the server understands them. Clients SHOULD use the next link, if present, to page through expansion results in preference to using the offset and count parameters. Due to the optional nature of the next link, its absence does not necessarily indicate that it is the last page of results. Instead, as the offset and count parameters SHALL be populated when paging, clients can reliably use the count/offset parameters to determine whether the whole expansion is returned.; (xsd)next:uri>?
< The time at which the expansion was produced by the expanding system. This SHOULD be a fully populated instant, but in some circumstances, value sets are expanded by hand, and the expansion is published without that precision.; (xsd)timestamp:dateTime>
< The total number of concepts in the expansion. If the number of concept nodes in this resource is less than the stated number, then the server can return more using the offset parameter. Paging only applies to flat expansions.; (xsd)total:integer>?
< If paging is being used, the offset at which this resource starts. I.e. this resource is a partial view into the expansion. If paging is not being used, this element SHALL NOT be present. Paging only applies to flat expansions. If a filter is applied, the count is the number of concepts that matched the filter, not the number of concepts in an unfiltered view of the expansion.; (xsd)offset:integer>?
[]< A parameter that controlled the expansion process. These parameters may be used by users of expanded value sets to check whether the expansion is suitable for a particular purpose, or to pick the correct expansion. The server decides which parameters to include here, but at a minimum, the list SHOULD include all of the parameters that affect the $expand operation. If the expansion will be persisted all of these parameters SHALL be included. If the codeSystem on the server has a specified version then this version SHALL be provided as a parameter in the expansion (note that not all code systems have a version).; (xsd)parameter:publishablevalueset.expansion.parameter>*
[]< A property defines an additional slot through which additional information can be provided about a concept.; (xsd)property:publishablevalueset.expansion.property>*
[]< The codes that are contained in the value set expansion.; (xsd)contains:publishablevalueset.expansion.contains>*🔗 The codes that are contained in the value set expansion.publishablevalueset.expansion.contains(xsd)(doc)=
<#base:ValueSet.expansion.contains>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< An absolute URI which is the code system in which the code for this item in the expansion is defined.; (xsd)system:uri>?
< If true, this entry is included in the expansion for navigational purposes, and the user cannot select the code directly as a proper value. This should not be understood to exclude its use for searching (e.g. by subsumption testing). The client should know whether it is appropriate for the user to select an abstract code or not.; (xsd)abstract:boolean>?
< If the concept is inactive in the code system that defines it. Inactive codes are those that are no longer to be used, but are maintained by the code system for understanding legacy data. It might not be known or specified whether a concept is inactive (and it may depend on the context of use). This should only have a value if the concept is inactive.; (xsd)inactive:boolean>?
< The version of the code system from this code was taken. 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. The exact value of the version string is specified by the system from which the code is derived.; (xsd)version:string>?
< The code for this item in the expansion hierarchy. If this code is missing the entry in the hierarchy is a place holder (abstract) and does not represent a valid code in the value set.; (xsd)code>?
< The recommended display for this item in the expansion.; (xsd)display:string>?
[]< Additional representations for this item - other languages, aliases, specialized purposes, used for particular purposes, etc. These are relevant when the conditions of the expansion do not fix to a single correct representation. The designations provided must be based on the value set and code system definitions.; (xsd)designation:ValueSet.compose.include.concept.designation>*
[]< A property value for this concept.; (xsd)property:publishablevalueset.expansion.contains.property>*
[]< Other codes and entries contained under this entry in the hierarchy. If the expansion uses this element, there is no implication about the logical relationship between them, and the structure cannot be used for logical inferencing. The structure exists to provide navigational assistance for helping human users to locate codes in the expansion.; (xsd)contains:ValueSet.expansion.contains>*🔗 A property value for this concept.publishablevalueset.expansion.contains.property(xsd)(doc)=
<#base:ValueSet.expansion.contains.property>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A code that is a reference to ValueSet.expansion.property.code.; (xsd)code>
(<valueBoolean:boolean>
|<valueCode:code>
|<valueCoding:Coding>
|<valueDateTime:dateTime>
|<valueDecimal:decimal>
|<valueInteger:integer>
|<valueString:string>)
[]< A subproperty value for this concept.; (xsd)subProperty:publishablevalueset.expansion.contains.property.subProperty>*🔗 A subproperty value for this concept.publishablevalueset.expansion.contains.property.subProperty(xsd)(doc)=
<#base:ValueSet.expansion.contains.property.subProperty>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A code that is a reference to ValueSet.expansion.property.code.; (xsd)code>
(<valueBoolean:boolean>
|<valueCode:code>
|<valueCoding:Coding>
|<valueDateTime:dateTime>
|<valueDecimal:decimal>
|<valueInteger:integer>
|<valueString:string>)🔗 A parameter that controlled the expansion process. These parameters may be used by users of expanded value sets to check whether the expansion is suitable for a particular purpose, or to pick the correct expansion. The server decides which parameters to include here, but at a minimum, the list SHOULD include all of the parameters that affect the $expand operation. If the expansion will be persisted all of these parameters SHALL be included. If the codeSystem on the server has a specified version then this version SHALL be provided as a parameter in the expansion (note that not all code systems have a version).publishablevalueset.expansion.parameter(xsd)(doc)=
<#base:ValueSet.expansion.parameter>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Name of the input parameter to the $expand operation; may be a server-assigned name for additional default or other server-supplied parameters used to control the expansion process. The names are assigned at the discretion of the server.; (xsd)name:string>
(<valueBoolean:boolean>
|<valueCode:code>
|<valueDateTime:dateTime>
|<valueDecimal:decimal>
|<valueInteger:integer>
|<valueString:string>
|<valueUri:uri>)?🔗 A property defines an additional slot through which additional information can be provided about a concept.publishablevalueset.expansion.property(xsd)(doc)=
<#base:ValueSet.expansion.property>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A code that is used to identify the property. The code is used in ValueSet.expansion.contains.property.code.; (xsd)code>
< Reference to the formal meaning of the property. One possible source of meaning is the [Concept Properties](codesystem-concept-properties.html) code system.; (xsd)uri>?🔗 Description of the semantic space the Value Set Expansion is intended to cover and should further clarify the text in ValueSet.description.publishablevalueset.scope(xsd)(doc)=
<#base:ValueSet.scope>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Criteria describing which concepts or codes should be included and why.; (xsd)inclusionCriteria:string>?
< Criteria describing which concepts or codes should be excluded and why.; (xsd)exclusionCriteria:string>?🔗 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(xsd)(doc)=
<#base:DataType>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< 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).; (xsd)value:decimal>?
< 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. Binding: quantity-comparator (required, How the Quantity should be understood and represented.); (xsd)comparator:code>?
< A human-readable form of the unit.; (xsd)unit:string>?
< The identification of the system that provides the coded form of the unit.; (xsd)system:uri>?
< 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.; (xsd)code>?🔗 A structured set of questions intended to guide the collection of answers from end-users. Questionnaires provide detailed control over order, presentation, phraseology and grouping to allow coherent, consistent data collection.Questionnaire(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< An absolute URI that is used to identify this questionnaire when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this questionnaire is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the questionnaire is stored on different servers. Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.
The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions).
In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.
The name of the referenced questionnaire can be conveyed using the http://hl7.org/fhir/StructureDefinition/display extension.; (xsd)url:uri>?
[]< A formal identifier that is used to identify this questionnaire when it is represented in other formats, or referenced in a specification, model, design or an instance. Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this questionnaire outside of FHIR, where it is not possible to use the logical URI.; (xsd)identifier:Identifier>*
< The identifier that is used to identify this version of the questionnaire when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the questionnaire author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. There may be different questionnaires that have the same url but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the questionnaire with the format. The version SHOULD NOT contain a '#' - see [Business Version](resource.html#bv-format).; (xsd)version:string>?
< Indicates the mechanism used to compare versions to determine which is more current. If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined. Binding: version-algorithm (extensible, ); (xsd)versionAlgorithm:(<Coding>
|<string>)>?
< A natural language name identifying the questionnaire. This name should be usable as an identifier for the module by machine processing applications such as code generation. The name is not expected to be globally unique. The name should be a simple alphanumeric type no-whitespace name to ensure that it is machine-processing friendly.; (xsd)name:string>?
< A short, descriptive, user-friendly title for the questionnaire. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.; (xsd)title:string>?
[]< The URL of a Questionnaire that this Questionnaire is based on. This element covers a broad range of relationships, from 'somewhat inspired by' to 'fully compliant with'. There is a standard extensionthat allows clearer differentiation between the specifics of the derivation relationship where this is needed - e.g. to determine substitutability and validation expectations - [http://hl7.org/fhir/StructureDefinition/questionnaire-derivationType](http://hl7.org/fhir/extensions/StructureDefinition-questionnaire-derivationType.html).; (xsd)derivedFrom:Questionnaire*>*
< The current state of this questionnaire. A nominal state-transition diagram can be found in the] documentation
Unknown does not represent 'other' - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization). Binding: publication-status (required, The lifecycle status of an artifact.); (xsd)status:code>
< A Boolean value to indicate that this questionnaire is authored for testing purposes (or education/evaluation/marketing) and is not intended for genuine usage. Allows filtering of questionnaires that are appropriate for use versus not.; (xsd)experimental:boolean>?
[]< The types of subjects that can be the subject of responses created for the questionnaire. If none are specified, then the subject is unlimited. Binding: resource-types (required, One of the resource types defined as part of this version of FHIR.); (xsd)subjectType:code>*
< The date (and optionally time) when the questionnaire was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the questionnaire changes. The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the questionnaire. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)date:dateTime>?
< The name of the organization or individual responsible for the release and ongoing maintenance of the questionnaire. Usually an organization but may be an individual. The publisher (or steward) of the questionnaire is the organization or individual primarily responsible for the maintenance and upkeep of the questionnaire. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the questionnaire. This item SHOULD be populated unless the information is available from context.; (xsd)publisher:string>?
[]< Contact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)contact:ContactDetail>*
< A free text natural language description of the questionnaire from a consumer's perspective. This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the questionnaire as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context. (E.g. the language of the questionnaire is presumed to be the predominant language in the place the questionnaire was created).; (xsd)description:markdown>?
[]< The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate questionnaires. When multiple useContexts are specified, there is no expectation that all or even any of the contexts apply.; (xsd)useContext:UsageContext>*
[]< A legal or geographic region in which the questionnaire is intended to be used. It may be possible for the questionnaire to be used in jurisdictions other than those for which it was originally designed or intended.
DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.) Binding: jurisdiction (extensible, Countries and regions within which this artifact is targeted for use.); (xsd)jurisdiction:CodeableConcept>*
< Explanation of why this questionnaire is needed and why it has been designed as it has. This element does not describe the usage of the questionnaire. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this questionnaire.; (xsd)purpose:markdown>?
< A copyright statement relating to the questionnaire and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the questionnaire.; (xsd)copyright:markdown>?
< A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved'). The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.; (xsd)copyrightLabel:string>?
< The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)approvalDate:date>?
< The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. If specified, this date follows the original approval date.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)lastReviewDate:date>?
< The period during which the questionnaire content was or is planned to be in active use. The effective period for a questionnaire determines when the content is applicable for usage and is independent of publication and review dates. For example, a questionnaire intended to be used for the year 2016 might be published in 2015.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)effectivePeriod:Period>?
[]< An identifier for this collection of questions in a particular terminology such as LOINC. Binding: questionnaire-questions (example, Codes for questionnaires, groups and individual questions.); (xsd)code:Coding>*
[]< A particular question, question grouping or display text that is part of the questionnaire. The content of the questionnaire is constructed from an ordered, hierarchical collection of items.; (xsd)item:Questionnaire.item>*🔗 A particular question, question grouping or display text that is part of the questionnaire. The content of the questionnaire is constructed from an ordered, hierarchical collection of items.Questionnaire.item(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< An identifier that is unique within the Questionnaire allowing linkage to the equivalent item in a QuestionnaireResponse resource. This ''can'' be a meaningful identifier (e.g. a LOINC code) but is not intended to have any meaning. GUIDs or sequential numbers are appropriate here.
LinkIds can have whitespaces and slashes by design. Tooling should not rely on linkIds being valid XHTML element IDs, and should not directly embed them as such; (xsd)linkId:string>
< This element is a URI that refers to an [ElementDefinition](elementdefinition.html) or to an [ObservationDefinition](observationdefinition.html) that provides information about this item, including information that might otherwise be included in the instance of the Questionnaire resource. A detailed description of the construction of the URI is shown in [Comments](questionnaire.html#definition), below. The uri refers to an ElementDefinition in a [StructureDefinition](structuredefinition.html#) or to an [ObservationDefinition](observationdefinition.html) and always starts with the [canonical URL](references.html#canonical) for the target resource. When referring to a StructureDefinition, a fragment identifier is used to specify the element definition by its id [Element.id](types-definitions.html#Element.id). E.g. http://hl7.org/fhir/StructureDefinition/Observation#Observation.value[x]. In the absence of a fragment identifier, the first/root element definition in the target is the matching element definition.; (xsd)definition:uri>?
[]< A terminology code that corresponds to this group or question (e.g. a code from LOINC, which defines many questions and answers). The value may come from the ElementDefinition referred to by .definition. Binding: questionnaire-questions (example, Codes for questionnaires, groups and individual questions.); (xsd)code:Coding>*
< A short label for a particular group, question or set of display text within the questionnaire used for reference by the individual completing the questionnaire. These are generally unique within a questionnaire, though this is not guaranteed. Some questionnaires may have multiple questions with the same label with logic to control which gets exposed. Typically, these won't be used for "display" items, though such use is not prohibited. Systems SHOULD NOT generate their own prefixes if prefixes are defined for any items within a Questionnaire.; (xsd)prefix:string>?
< The name of a section, the text of a question or text content for a display item. When using this element to represent the name of a section, use group type item and also make sure to limit the text element to a short string suitable for display as a section heading. Group item instructions should be included as a display type item within the group.; (xsd)text:string>?
< The type of questionnaire item this is - whether text for display, a grouping of other items or a particular type of data to be captured (string, integer, Coding, etc.). Additional constraints on the type of answer can be conveyed by extensions. The value may come from the ElementDefinition referred to by .definition. Binding: item-type (required, Distinguishes groups from questions and display text and indicates data type for questions.); (xsd)type:code>
[]< A constraint indicating that this item should only be enabled (displayed/allow answers to be captured) when the specified condition is true. If multiple repetitions of this extension are present, the interpretation is driven by enableBehavior (either all repetitions must evaluate to true for this item to be enabled, or only one must evaluate to true for the item to be enabled). If the enableWhen.question has multiple answers, the condition evaluates to true if *any* of the answers for the referenced item match the enableWhen condition. This element is a modifier because if enableWhen is present for an item, "required" is ignored unless one of the enableWhen conditions is met. When an item is disabled, all of its descendants are disabled, regardless of what their own enableWhen logic might evaluate to. If enableWhen logic depends on an item that is disabled, the logic should proceed as though the item is not valued - even if a default value or other value might be retained in memory in the event of the item being re-enabled. In some cases, the comparison between the indicated answer and the specified value may differ only by precision. For example, the enableWhen might be Q1 > 1970, but the answer to Q1 is 1970-10-15. There is not a clear answer as to whether 1970-10-15 should be considered 'greater' than 1970, given that it is an imprecise value. In these indeterminate situations, the form filler has the option of refusing to render the form. If the form **is** displayed, items where enableWhen is indeterminate SHOULD be treated as enabled with a warning indicating that the questionnaire logic was faulty and it is possible that the item should not be enabled. Questionnaires SHOULD be designed to take into account challenges around varying precision to minimize non-deterministic situations by setting constraints around expected precision, etc.; (xsd)enableWhen:Questionnaire.item.enableWhen>*
< Controls how multiple enableWhen values are interpreted - whether all or any must be true. This element must be specified if more than one enableWhen value is provided. Binding: questionnaire-enable-behavior (required, Controls how multiple enableWhen values are interpreted - whether all or any must be true.); (xsd)enableBehavior:code>?
< Indicates if and how items that are disabled (because enableWhen evaluates to 'false') should be displayed. If not specified, rendering behavior is up to the client. This element is only meaningful if enableWhen or an equivalent extension is present Binding: questionnaire-disabled-display (required, Defines how disabled elements should be rendered); (xsd)disabledDisplay:code>?
< An indication, if true, that the item must be present in a "completed" QuestionnaireResponse. If false, the item may be skipped when answering the questionnaire. If the required item is a question, it must have a direct answer (i.e. an answer to the question itself, not merely answers to child questions) in order for the QuestionnaireResponse to be complete. If the required item is a group, it must have at least one descendant question which has an answer Questionnaire.item.required only has meaning for elements that are conditionally enabled with enableWhen if the condition evaluates to true. It also only has meaning if the parent element is present. If a non-required 'group' item contains a 'required' question item, it's completely fine to omit the group (because it's not required) despite it having a required child. Similarly, if an item that contains other items is marked as required, that does not automatically make the contained elements required (though required groups must contain at least one descendant item with a populated answer). The value for 'required' may come from the ElementDefinition referred to by .definition.; (xsd)required:boolean>?
< An indication, if true, that a QuestionnaireResponse for this item may include multiple answers associated with a single instance of this item (for question-type items) or multiple repetitions of the item (for group-type items). If a question is marked as repeats=true, then multiple answers can be provided for the question in the corresponding QuestionnaireResponse. When rendering the questionnaire, it is up to the rendering software whether to render the question text for each answer repetition (i.e. "repeat the question") or to simply allow entry/selection of multiple answers for the question (repeat the answers). Which is most appropriate visually may depend on the type of answer as well as whether there are nested items.
The resulting QuestionnaireResponse will be populated the same way regardless of rendering - one 'question' item with multiple answer values.
The value may come from the ElementDefinition referred to by .definition. When repeats=true for a group, it'll be represented with multiple items with the same linkId in the QuestionnaireResponse. For a question, it'll be represented by a single item with that linkId with multiple answers.; (xsd)repeats:boolean>?
< An indication, when true, that the value cannot be changed by a human respondent to the Questionnaire. If specified on a 'group', then all items beneath the specified group are read only. For questions, this only marks the answer associated with the specific item read only. Descendant questions are not impacted. The value of readOnly elements can be established by asserting extensions for defaultValues, linkages that support pre-population and/or extensions that support calculation based on other answers.; (xsd)readOnly:boolean>?
< The maximum number of characters that are permitted in the answer to be considered a "valid" QuestionnaireResponse. For base64binary, reflects the number of characters representing the encoded data, not the number of bytes of the binary data. The value may come from the ElementDefinition referred to by .definition.; (xsd)maxLength:integer>?
< For items that have a defined set of allowed answers (via answerOption or answerValueSet), indicates whether values *other* than those specified can be selected. Binding: questionnaire-answer-constraint (required, Indicates differnt modes for restricting values when options or valueset are specified); (xsd)answerConstraint:code>?
< A reference to a value set containing a list of values representing permitted answers for a question. LOINC defines many useful value sets for questionnaire responses. See [LOINC Answer Lists](https://terminology.hl7.org/LOINC.html). The value may come from the ElementDefinition referred to by .definition.; (xsd)answerValueSet:ValueSet*>?
[]< One of the permitted answers for the question. This element can be used when the value set machinery of answerValueSet is deemed too cumbersome or when there's a need to capture possible answers that are not codes.; (xsd)answerOption:Questionnaire.item.answerOption>*
[]< One or more values that should be pre-populated in the answer when initially rendering the questionnaire for user input. The user is allowed to change the value and override the default (unless marked as read-only). If the user doesn't change the value, then this initial value will be persisted when the QuestionnaireResponse is initially created. Note that initial values can influence results. The data type of initial.answer[x] must agree with the item.type, and only repeating items can have more then one initial value.; (xsd)initial:Questionnaire.item.initial>*
[]< Text, questions and other groups to be nested beneath a question or group. There is no specified limit to the depth of nesting. However, Questionnaire authors are encouraged to consider the impact on the user and user interface of overly deep nesting.; (xsd)item:Questionnaire.item>*🔗 One of the permitted answers for the question. This element can be used when the value set machinery of answerValueSet is deemed too cumbersome or when there's a need to capture possible answers that are not codes.Questionnaire.item.answerOption(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
(<valueCoding:Coding>
|<valueDate:date>
|<valueInteger:integer>
|<valueResource:Resource>
|<valueString:string>
|<valueTime:time>)
< Indicates whether the answer value is selected when the list of possible answers is initially shown.; (xsd)initialSelected:boolean>?🔗 A constraint indicating that this item should only be enabled (displayed/allow answers to be captured) when the specified condition is true. If multiple repetitions of this extension are present, the interpretation is driven by enableBehavior (either all repetitions must evaluate to true for this item to be enabled, or only one must evaluate to true for the item to be enabled). If the enableWhen.question has multiple answers, the condition evaluates to true if *any* of the answers for the referenced item match the enableWhen condition. This element is a modifier because if enableWhen is present for an item, "required" is ignored unless one of the enableWhen conditions is met. When an item is disabled, all of its descendants are disabled, regardless of what their own enableWhen logic might evaluate to. If enableWhen logic depends on an item that is disabled, the logic should proceed as though the item is not valued - even if a default value or other value might be retained in memory in the event of the item being re-enabled. In some cases, the comparison between the indicated answer and the specified value may differ only by precision. For example, the enableWhen might be Q1 > 1970, but the answer to Q1 is 1970-10-15. There is not a clear answer as to whether 1970-10-15 should be considered 'greater' than 1970, given that it is an imprecise value. In these indeterminate situations, the form filler has the option of refusing to render the form. If the form **is** displayed, items where enableWhen is indeterminate SHOULD be treated as enabled with a warning indicating that the questionnaire logic was faulty and it is possible that the item should not be enabled. Questionnaires SHOULD be designed to take into account challenges around varying precision to minimize non-deterministic situations by setting constraints around expected precision, etc.Questionnaire.item.enableWhen(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The linkId for the question whose answer (or lack of answer) governs whether this item is enabled. If multiple question occurrences are present for the same question (same linkId), then this refers to the nearest question occurrence reachable by tracing first the "ancestor" axis and then the "preceding" axis and then the "following" axis. If there are multiple items with the same linkId and all are equadistant (e.g. a question references a question that appears in a separate repeating group), that is an error. (Consider using the enableWhenExpression extension to define logic to handle such a situation.); (xsd)question:string>
< Specifies the criteria by which the question is enabled. Binding: questionnaire-enable-operator (required, The criteria by which a question is enabled.); (xsd)operator:code>
< A value that the referenced question is tested using the specified operator in order for the item to be enabled. If there are multiple answers, a match on any of the answers suffices. If different behavior is desired (all must match, at least 2 must match, etc.), consider using the enableWhenExpression extension. Binding: questionnaire-answers (example, Allowed values to answer questions.); (xsd)answer:(<boolean>
|<Coding>
|<date>
|<dateTime>
|<decimal>
|<integer>
|<Quantity>
|<Resource>
|<string>
|<time>)>🔗 One or more values that should be pre-populated in the answer when initially rendering the questionnaire for user input. The user is allowed to change the value and override the default (unless marked as read-only). If the user doesn't change the value, then this initial value will be persisted when the QuestionnaireResponse is initially created. Note that initial values can influence results. The data type of initial.answer[x] must agree with the item.type, and only repeating items can have more then one initial value.Questionnaire.item.initial(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
(<valueAttachment:Attachment>
|<valueBoolean:boolean>
|<valueCoding:Coding>
|<valueDate:date>
|<valueDateTime:dateTime>
|<valueDecimal:decimal>
|<valueInteger:integer>
|<valueQuantity:Quantity>
|<valueResource:Resource>
|<valueString:string>
|<valueTime:time>
|<valueUri:uri>)🔗 A structured set of questions and their answers. The questions are ordered and grouped into coherent subsets, corresponding to the structure of the grouping of the questionnaire being responded to. The QuestionnaireResponse contains enough information about the questions asked and their organization that it can be interpreted somewhat independently from the Questionnaire it is based on. I.e. You don't need access to the Questionnaire in order to extract basic information from a QuestionnaireResponse.QuestionnaireResponse(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< Business identifiers assigned to this questionnaire response by the performer and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server. Note: This is a business identifier, not a resource identifier (see [discussion](resource.html#identifiers)).; (xsd)identifier:Identifier>*
[]< A plan, proposal or order that is fulfilled in whole or in part by this questionnaire response. For example, a ServiceRequest seeking an intake assessment or a decision support recommendation to assess for post-partum depression.; (xsd)basedOn:(<CarePlan>
|<ServiceRequest>)>*
[]< A procedure or observation that this questionnaire was performed as part of the execution of. For example, the surgery a checklist was executed as part of. Not to be used to link an questionnaire response to an Encounter - use 'context' for that.
Composition of questionnaire responses will be handled using the Assemble operation defined in the SDC IG. For relationships to referrals, and other types of requests, use basedOn.; (xsd)partOf:(<Observation>
|<Procedure>)>*
< The Questionnaire that defines and organizes the questions for which answers are being provided. If a QuestionnaireResponse references a Questionnaire that can be resolved, then the QuestionnaireResponse structure must be consistent with the Questionnaire (i.e. questions must be organized into the same groups, nested questions must still be nested, etc.). It is possible to have a QuestionnaireResponse whose 'questionnaire' element does not resolve. It is also possible for the questionnaire element to not have a value but only extensions (e.g. conveying the title or identifier for the questionnaire). This may happen for legacy data. If there is no formally defined Questionnaire, it is undefined what the 'correct' values for the linkId elements should be and it is possible that linkIds might be inconsistent for QuestionnaireResponses for the same form if captured by distinct systems.; (xsd)questionnaire:Questionnaire*>
< The current state of the questionnaire response. Unknown does not represent "other" - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is. Binding: questionnaire-answers-status (required, Lifecycle status of the questionnaire response.); (xsd)status:code>
< The subject of the questionnaire response. This could be a patient, organization, practitioner, device, etc. This is who/what the answers apply to, but is not necessarily the source of information. If the Questionnaire declared a subjectType, the resource pointed to by this element must be an instance of one of the listed types.; (xsd)subject:Resource*>?
< The Encounter during which this questionnaire response was created or to which the creation of this record is tightly associated. This will typically be the encounter the questionnaire response was created during, but some questionnaire responses may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission forms). A questionnaire that was initiated during an encounter but not fully completed during the encounter would still generally be associated with the encounter.; (xsd)encounter:Encounter*>?
< The date and/or time that this questionnaire response was last modified by the user - e.g. changing answers or revising status. May be different from the lastUpdateTime of the resource itself, because that reflects when the data was known to the server, not when the data was captured.
This element is optional to allow for systems that might not know the value, however it SHOULD be populated if possible.; (xsd)authored:dateTime>?
< The individual or device that received the answers to the questions in the QuestionnaireResponse and recorded them in the system. Mapping a subject's answers to multiple choice options and determining what to put in the textual answer is a matter of interpretation. Authoring by device would indicate that some portion of the questionnaire had been auto-populated. Device should only be used if it directly determined the answers, not if it was merely used as a capture tool to record answers provided by others. In the latter case, information about the physical device, software, etc. would be captured using Provenance.; (xsd)author:(<Device>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>?
< The individual or device that answered the questions about the subject. If not specified, no inference can be made about who provided the data. Device should only be used if it directly determined the answers, not if it was merely used as a capture tool to record answers provided by others. In the latter case, information about the physical device, software, etc. would be captured using Provenance.; (xsd)source:(<Device>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>?
[]< A group or question item from the original questionnaire for which answers are provided. Groups cannot have answers and therefore must nest directly within item. When dealing with questions, nesting must occur within each answer because some questions may have multiple answers (and the nesting occurs for each answer).\nWhen dealing with repeating items, each group repetition will be handled by a separate item. However, repeating questions are handled with a single question item and potentially multiple answers.; (xsd)item:QuestionnaireResponse.item>*🔗 A group or question item from the original questionnaire for which answers are provided. Groups cannot have answers and therefore must nest directly within item. When dealing with questions, nesting must occur within each answer because some questions may have multiple answers (and the nesting occurs for each answer).\nWhen dealing with repeating items, each group repetition will be handled by a separate item. However, repeating questions are handled with a single question item and potentially multiple answers.QuestionnaireResponse.item(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The item from the Questionnaire that corresponds to this item in the QuestionnaireResponse resource.; (xsd)linkId:string>
< A reference to an [ElementDefinition](elementdefinition.html) that provides the details for the item. The ElementDefinition must be in a [StructureDefinition](structuredefinition.html#), and must have a fragment identifier that identifies the specific data element by its id (Element.id). E.g. http://hl7.org/fhir/StructureDefinition/Observation#Observation.value[x].
There is no need for this element if the item pointed to by the linkId has a definition listed.; (xsd)definition:uri>?
< Text that is displayed above the contents of the group or as the text of the question being answered. The text for an item SHOULD be identical to the text from the corresponding Questionnaire.item. This can't be strictly enforced because it's possible for the Questionnaire to be updated subsequent to the QuestionnaireResponse having been created, however the intention is that the text in the QuestionnaireResponse reflects what the user saw when completing the Questionnaire.; (xsd)text:string>?
[]< The respondent's answer(s) to the question. The value is nested because we cannot have a repeating structure that has variable type.; (xsd)answer:QuestionnaireResponse.item.answer>*
[]< Sub-questions, sub-groups or display items nested beneath a group. Only used when nesting beneath a group - see item.answer.item for nesting beneath questions; (xsd)item:QuestionnaireResponse.item>*🔗 The respondent's answer(s) to the question. The value is nested because we cannot have a repeating structure that has variable type.QuestionnaireResponse.item.answer(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
(<valueAttachment:Attachment>
|<valueBoolean:boolean>
|<valueCoding:Coding>
|<valueDate:date>
|<valueDateTime:dateTime>
|<valueDecimal:decimal>
|<valueInteger:integer>
|<valueResource:Resource>
|<valueSimpleQuantity:SimpleQuantity>
|<valueString:string>
|<valueTime:time>
|<valueUri:uri>)
[]< Nested groups and/or questions found within this particular answer. Only used when nesting beneath a question - see item.item for nesting beneath groups; (xsd)item:QuestionnaireResponse.item>*🔗 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(xsd)(doc)=
<#base:DataType>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< The low limit. The boundary is inclusive. If the low element is missing, the low boundary is not known.; (xsd)low:SimpleQuantity>?
< The high limit. The boundary is inclusive. If the high element is missing, the high boundary is not known.; (xsd)high:SimpleQuantity>?🔗 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(xsd)(doc)=
<#base:DataType>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< The value of the numerator.; (xsd)numerator:Quantity>?
< The value of the denominator.; (xsd)denominator:SimpleQuantity>?🔗 A range of ratios expressed as a low and high numerator and a denominator. 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.RatioRange(xsd)(doc)=
<#base:DataType>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< The value of the low limit numerator. If the low element is missing, the low boundary is not known.; (xsd)lowNumerator:SimpleQuantity>?
< The value of the high limit numerator. If the high element is missing, the high boundary is not known.; (xsd)highNumerator:SimpleQuantity>?
< The value of the denominator.; (xsd)denominator:SimpleQuantity>?🔗 A reference from one resource to another. References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.Reference(xsd)(doc)=
<#base:DataType>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< 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.; (xsd)reference:string>?
< 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 known RESTful URL) or by resolving the target of the reference. Binding: resource-types (extensible, Aa resource (or, for logical models, the URI of the logical model).); (xsd)type:uri>?
< 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).
This element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.; (xsd)identifier:Identifier>?
< 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.; (xsd)display:string>?🔗 Regulatory approval, clearance or licencing related to a regulated product, treatment, facility or activity that is cited in a guidance, regulation, rule or legislative act. An example is Market Authorization relating to a Medicinal Product.RegulatedAuthorization(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< Business identifier for the authorization, typically assigned by the authorizing body.; (xsd)identifier:Identifier>*
[]< The product type, treatment, facility or activity that is being authorized.; (xsd)subject:(<ActivityDefinition>
|<BiologicallyDerivedProduct>
|<DeviceDefinition>
|<Ingredient>
|<Location>
|<ManufacturedItemDefinition>
|<MedicinalProductDefinition>
|<NutritionProduct>
|<ObservationDefinition>
|<Organization>
|<PackagedProductDefinition>
|<PlanDefinition>
|<Practitioner>
|<ResearchStudy>
|<SubstanceDefinition>)>*
< Overall type of this authorization, for example drug marketing approval, orphan drug designation. Binding: regulated-authorization-type (example, Overall type of this authorization.); (xsd)type:CodeableConcept>?
< General textual supporting information.; (xsd)description:markdown>?
[]< The territory (e.g., country, jurisdiction etc.) in which the authorization has been granted. Binding: jurisdiction (example, Jurisdiction codes); (xsd)region:CodeableConcept>*
< The status that is authorised e.g. approved. Intermediate states and actions can be tracked with cases and applications. Binding: publication-status (preferred, The lifecycle status of an artifact.); (xsd)status:CodeableConcept>?
< The date at which the current status was assigned.; (xsd)statusDate:dateTime>?
< The time period in which the regulatory approval, clearance or licencing is in effect. As an example, a Marketing Authorization includes the date of authorization and/or an expiration date.; (xsd)validityPeriod:Period>?
[]< Condition for which the use of the regulated product applies.; (xsd)indication:ClinicalUseDefinition*>*
< The intended use of the product, e.g. prevention, treatment, diagnosis. Binding: product-intended-use (preferred, The overall intended use of a product.); (xsd)intendedUse:CodeableConcept>?
[]< The legal or regulatory framework against which this authorization is granted, or other reasons for it. Binding: regulated-authorization-basis (example, A legal or regulatory framework against which an authorization is granted, or other reasons for it.); (xsd)basis:CodeableConcept>*
< The organization that has been granted this authorization, by some authoritative body (the 'regulator').; (xsd)holder:Organization*>?
< The regulatory authority or authorizing body granting the authorization. For example, European Medicines Agency (EMA), Food and Drug Administration (FDA), Health Canada (HC), etc.; (xsd)regulator:Organization*>?
[]< Additional information or supporting documentation about the authorization.; (xsd)attachedDocument:DocumentReference*>*
< The case or regulatory procedure for granting or amending a regulated authorization. An authorization is granted in response to submissions/applications by those seeking authorization. A case is the administrative process that deals with the application(s) that relate to this and assesses them. Note: This area is subject to ongoing review and the workgroup is seeking implementer feedback on its use (see link at bottom of page).; (xsd)case:RegulatedAuthorization.case>?🔗 The case or regulatory procedure for granting or amending a regulated authorization. An authorization is granted in response to submissions/applications by those seeking authorization. A case is the administrative process that deals with the application(s) that relate to this and assesses them. Note: This area is subject to ongoing review and the workgroup is seeking implementer feedback on its use (see link at bottom of page).RegulatedAuthorization.case(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Identifier by which this case can be referenced.; (xsd)identifier:Identifier>?
< The defining type of case. Binding: regulated-authorization-case-type (example, The type of a case involved in an application.); (xsd)type:CodeableConcept>?
< The status associated with the case. Binding: publication-status (preferred, The lifecycle status of an artifact.); (xsd)status:CodeableConcept>?
< Relevant date for this case.; (xsd)date:(<dateTime>
|<Period>)>?
[]< A regulatory submission from an organization to a regulator, as part of an assessing case. Multiple applications may occur over time, with more or different information to support or modify the submission or the authorization. The applications can be considered as steps within the longer running case or procedure for this authorization process.; (xsd)application:RegulatedAuthorization.case>*🔗 An ExtensionRegulatorySummary(xsd)(doc)=
<#base:Extension>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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. http://hl7.org/fhir/uv/order-catalog/StructureDefinition/RegulatorySummary; (xsd)url:string>
< Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R5/extensibility.html) for a list).; (xsd)value:string>?🔗 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(xsd)(doc)=
<#base:DataType>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< The type of relationship to the related artifact. The presence of both sides of a relationship type (e.g. successor and predecessor) is required to support use cases where one side of a relationship is not represented in FHIR. However, this feature SHALL NOT be used to create bi-directional resource links in FHIR instances. Specifically, following the methodology of "new points to old" and "many points to one", when using related artifact elements to describe and reference FHIR resources, the type element SHALL be drawn from the fhir-related-artifact-type ValueSet. Binding: related-artifact-type (required, The type of relationship to the related artifact.); (xsd)type:code>
[]< Provides additional classifiers of the related artifact. Binding: citation-artifact-classifier (example, Additional classifiers for the related artifact.); (xsd)classifier:CodeableConcept>*
< A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index.; (xsd)label:string>?
< A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.; (xsd)display:string>?
< 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.; (xsd)citation:markdown>?
< The document being referenced, represented as an attachment. This is exclusive with the resource element.; (xsd)document:Attachment>?
< The related artifact, 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.; (xsd)resource:Resource*>?
< The related artifact, if the artifact is not a canonical resource, or a resource reference to a canonical resource. If both resource and resourceReference are present, they SHOULD be consistent and reference the same resource. Although relatedArtifact is intended to support references to definitional resources, there are cases where non-definitional resources can be definitional (such as Location where the kind is mode). Related artifacts SHOULD be used to reference definitional resources, and profiles SHOULD be used to make that explicit for particular use cases.; (xsd)resourceReference:Resource*>?
< The publication status of the artifact being referred to. Binding: publication-status (required, Publication status of an artifact being referred to.); (xsd)publicationStatus:code>?
< The date of publication of the artifact being referred to.; (xsd)publicationDate:date>?🔗 Information about a person that is involved in a patient's health or the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process.RelatedPerson(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< Identifier for a person within a particular scope. RelatedPerson identifiers might not be unique across instances within a system, as a single human individual may be represented as many different RelatedPerson resources with different roles, periods, or relationships.; (xsd)identifier:Identifier>*
< Whether this related person record is in active use. This element is labeled as a modifier because it may be used to mark that the resource was created in error.; (xsd)active:boolean>?
< The patient this person is related to.; (xsd)patient:Patient*>
[]< The nature of the relationship between the related person and the patient. The directionality of the relationship is from the RelatedPerson to the Patient. For example, if the Patient is a child, and the RelatedPerson is the mother, the relationship would be PRN (parent) or MTH (mother). Binding: relatedperson-relationshiptype (preferred, The nature of the relationship between a patient and the related person.); (xsd)relationship:CodeableConcept>*
[]< A name associated with the person.; (xsd)name:HumanName>*
[]< A contact detail for the person, e.g. a telephone number or an email address. Person may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently, and also to help with identification.; (xsd)telecom:ContactPoint>*
< Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes. Binding: administrative-gender (required, The gender of a person used for administrative purposes.); (xsd)gender:code>?
< The date on which the related person was born.; (xsd)birthDate:date>?
[]< Address where the related person can be contacted or visited.; (xsd)address:Address>*
[]< Image of the person.; (xsd)photo:Attachment>*
< The period of time during which this relationship is or was active. If there are no dates defined, then the interval is unknown. If an individual has a relationship with a patient over multiple, non-adjacent periods, there should be a distinct RelatedPerson instance for each period. For example, if a person is a roommate for a period of time, moves out, and is later a roommate with the same person again, you would have two RelatedPerson instances.; (xsd)period:Period>?
[]< A language which may be used to communicate with the related person about the patient's health. If no language is specified, this *implies* that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple RelatedPerson.Communication associations. If the RelatedPerson does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required.; (xsd)communication:RelatedPerson.communication>*🔗 A language which may be used to communicate with the related person about the patient's health. If no language is specified, this *implies* that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple RelatedPerson.Communication associations. If the RelatedPerson does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required.RelatedPerson.communication(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. "en" for English, or "en-US" for American English versus "en-AU" for Australian English. The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type. Binding: all-languages (required, IETF language tag for a human language); (xsd)language:CodeableConcept>
< Indicates whether or not the related person prefers this language (over other languages he or she masters up a certain level). This language is specifically identified for communicating healthcare information.; (xsd)preferred:boolean>?🔗 A set of related requests that can be used to capture intended activities that have inter-dependencies such as "give this medication after that one".RequestOrchestration(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< Allows a service to provide a unique, business identifier for the request.; (xsd)identifier:Identifier>*
[]< A canonical URL referencing a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.; (xsd)instantiatesCanonical:Resource*>*
[]< A URL referencing an externally defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.; (xsd)instantiatesUri:uri>*
[]< A plan, proposal or order that is fulfilled in whole or in part by this request.; (xsd)basedOn:Resource*>*
[]< Completed or terminated request(s) whose function is taken by this new request. The replacement could be because the initial request was immediately rejected (due to an issue) or because the previous request was completed, but the need for the action described by the request remains ongoing.; (xsd)replaces:Resource*>*
< A shared identifier common to multiple independent Request instances that were activated/authorized more or less simultaneously by a single author. The presence of the same identifier on each request ties those requests together and may have business ramifications in terms of reporting of results, billing, etc. E.g. a requisition number shared by a set of lab tests ordered together, or a prescription number shared by all meds ordered at one time. Requests are linked either by a "basedOn" relationship (i.e. one request is fulfilling another) or by having a common requisition. Requests that are part of the same requisition are generally treated independently from the perspective of changing their state or maintaining them after initial creation.; (xsd)groupIdentifier:Identifier>?
< The current state of the request. For request orchestrations, the status reflects the status of all the requests in the orchestration. Binding: request-status (required, Codes identifying the lifecycle stage of a request.); (xsd)status:code>
< Indicates the level of authority/intentionality associated with the request and where the request fits into the workflow chain. Binding: request-intent (required, Codes indicating the degree of authority/intentionality associated with a request.); (xsd)intent:code>
< Indicates how quickly the request should be addressed with respect to other requests. Binding: request-priority (required, Identifies the level of importance to be assigned to actioning the request.); (xsd)priority:code>?
< A code that identifies what the overall request orchestration is. This element can be used to provide a code that captures the meaning of the request orchestration as a whole, as opposed to the code of the action element, which captures the meaning of the individual actions within the request orchestration. Binding: action-code (example, ); (xsd)code:CodeableConcept>?
< The subject for which the request orchestration was created.; (xsd)subject:(<CareTeam>
|<Device>
|<Group>
|<HealthcareService>
|<Location>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>?
< Describes the context of the request orchestration, if any.; (xsd)encounter:Encounter*>?
< Indicates when the request orchestration was created.; (xsd)authoredOn:dateTime>?
< Provides a reference to the author of the request orchestration.; (xsd)author:(<Device>
|<Practitioner>
|<PractitionerRole>)>?
[]< Describes the reason for the request orchestration in coded or textual form. Binding: action-reason-code (example, ); (xsd)reason:(<Condition>
|<DiagnosticReport>
|<DocumentReference>
|<Observation>)>*
[]< Goals that are intended to be achieved by following the requests in this RequestOrchestration.; (xsd)goal:Goal*>*
[]< Provides a mechanism to communicate additional information about the response.; (xsd)note:Annotation>*
[]< The actions, if any, produced by the evaluation of the artifact.; (xsd)action:RequestOrchestration.action>*🔗 The actions, if any, produced by the evaluation of the artifact.RequestOrchestration.action(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The linkId of the action from the PlanDefinition that corresponds to this action in the RequestOrchestration resource.; (xsd)linkId:string>?
< A user-visible prefix for the action. For example a section or item numbering such as 1. or A.; (xsd)prefix:string>?
< The title of the action displayed to a user.; (xsd)title:string>?
< A short description of the action used to provide a summary to display to the user.; (xsd)description:markdown>?
< A text equivalent of the action to be performed. This provides a human-interpretable description of the action when the definition is consumed by a system that might not be capable of interpreting it dynamically.; (xsd)textEquivalent:markdown>?
< Indicates how quickly the action should be addressed with respect to other actions. Binding: request-priority (required, Identifies the level of importance to be assigned to actioning the request.); (xsd)priority:code>?
[]< A code that provides meaning for the action or action group. For example, a section may have a LOINC code for a section of a documentation template. Binding: action-code (example, ); (xsd)code:CodeableConcept>*
[]< Didactic or other informational resources associated with the action that can be provided to the CDS recipient. Information resources can include inline text commentary and links to web resources.; (xsd)documentation:RelatedArtifact>*
[]< Goals that are intended to be achieved by following the requests in this action.; (xsd)goal:Goal*>*
[]< An expression that describes applicability criteria, or start/stop conditions for the action. When multiple conditions of the same kind are present, the effects are combined using AND semantics, so the overall condition is true only if all of the conditions are true.; (xsd)condition:RequestOrchestration.action.condition>*
[]< Defines input data requirements for the action.; (xsd)input:RequestOrchestration.action.input>*
[]< Defines the outputs of the action, if any.; (xsd)output:RequestOrchestration.action.output>*
[]< A relationship to another action such as "before" or "30-60 minutes after start of".; (xsd)relatedAction:RequestOrchestration.action.relatedAction>*
< An optional value describing when the action should be performed. The intent of the timing element is to provide timing for when the action should be performed. The timing may be absolute (specified as a dateTime or Period) or relative (specified as an Age, Duration, or Range), or it may be a more complex, potentially repeating timing specified using Timing.; (xsd)timing:(<Age>
|<dateTime>
|<Duration>
|<Period>
|<Range>
|<Timing>)>?
< Identifies the facility where the action will occur; e.g. home, hospital, specific clinic, etc. May reference a specific clinical location or may just identify a type of location.; (xsd)location:Location*>?
[]< The participant that should perform or be responsible for this action. Because request orchestrations represent potential options for performing activities, some specific participants may still be unknown, so this element allows for both definitional participants (in the same way they are specified in ActivityDefinition and PlanDefinition resources) as well as identifying specific participants when they are known.; (xsd)participant:RequestOrchestration.action.participant>*
< The type of action to perform (create, update, remove). Binding: action-type (extensible, The type of action to be performed.); (xsd)type:CodeableConcept>?
< Defines the grouping behavior for the action and its children. Binding: action-grouping-behavior (required, Defines organization behavior of a group.); (xsd)groupingBehavior:code>?
< Defines the selection behavior for the action and its children. Binding: action-selection-behavior (required, Defines selection behavior of a group.); (xsd)selectionBehavior:code>?
< Defines expectations around whether an action is required. Binding: action-required-behavior (required, Defines expectations around whether an action or action group is required.); (xsd)requiredBehavior:code>?
< Defines whether the action should usually be preselected. Binding: action-precheck-behavior (required, Defines selection frequency behavior for an action or group.); (xsd)precheckBehavior:code>?
< Defines whether the action can be selected multiple times. Binding: action-cardinality-behavior (required, Defines behavior for an action or a group for how many times that item may be repeated.); (xsd)cardinalityBehavior:code>?
< The resource that is the target of the action (e.g. CommunicationRequest). The target resource SHALL be a [Request](request.html) resource with a Request.intent set to "option".; (xsd)resource:Resource*>?
< A reference to an ActivityDefinition that describes the action to be taken in detail, a PlanDefinition that describes a series of actions to be taken, a Questionnaire that should be filled out, a SpecimenDefinition describing a specimen to be collected, or an ObservationDefinition that specifies what observation should be captured. Note that the definition is optional, and if no definition is specified, a dynamicValue with a root ($this) path can be used to define the entire resource dynamically.; (xsd)definition:(<ActivityDefinition>
|<ObservationDefinition>
|<PlanDefinition>
|<Questionnaire>
|<SpecimenDefinition>
|<uri>)>?
< A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input. Note that when a referenced ActivityDefinition also defines a transform, the transform specified here generally takes precedence. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.; (xsd)transform:StructureMap*>?
[]< Customizations that should be applied to the statically defined resource. For example, if the dosage of a medication must be computed based on the patient's weight, a customization would be used to specify an expression that calculated the weight, and the path on the resource that would contain the result. Dynamic values are applied in the order in which they are defined in the RequestOrchestration resource. Note that when dynamic values are also specified by a referenced ActivityDefinition, the dynamicValues from the ActivityDefinition are applied first, followed by the dynamicValues specified here. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.; (xsd)dynamicValue:RequestOrchestration.action.dynamicValue>*
[]< Sub actions.; (xsd)action:RequestOrchestration.action>*🔗 An expression that describes applicability criteria, or start/stop conditions for the action. When multiple conditions of the same kind are present, the effects are combined using AND semantics, so the overall condition is true only if all of the conditions are true.RequestOrchestration.action.condition(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The kind of condition. Applicability criteria are used to determine immediate applicability when a plan definition is applied to a given context. Start and stop criteria are carried through application and used to describe enter/exit criteria for an action. Binding: action-condition-kind (required, The kind of condition for the action.); (xsd)kind:code>
< An expression that returns true or false, indicating whether or not the condition is satisfied. The expression may be inlined, or may be a reference to a named expression within a logic library referenced by the library element.; (xsd)expression:Expression>?🔗 Customizations that should be applied to the statically defined resource. For example, if the dosage of a medication must be computed based on the patient's weight, a customization would be used to specify an expression that calculated the weight, and the path on the resource that would contain the result. Dynamic values are applied in the order in which they are defined in the RequestOrchestration resource. Note that when dynamic values are also specified by a referenced ActivityDefinition, the dynamicValues from the ActivityDefinition are applied first, followed by the dynamicValues specified here. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.RequestOrchestration.action.dynamicValue(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The path to the element to be customized. This is the path on the resource that will hold the result of the calculation defined by the expression. The specified path SHALL be a FHIRPath resolvable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. 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). To specify the path to the current action being realized, the %action environment variable is available in this path. For example, to specify the description element of the target action, the path would be %action.description. The path attribute contains a [Simple FHIRPath Subset](fhirpath.html#simple) that allows path traversal, but not calculation.; (xsd)path:string>?
< An expression specifying the value of the customized element. The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.; (xsd)expression:Expression>?🔗 Defines input data requirements for the action.RequestOrchestration.action.input(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A human-readable label for the data requirement used to label data flows in BPMN or similar diagrams. Also provides a human readable label when rendering the data requirement that conveys its purpose to human readers.; (xsd)title:string>?
< Defines the data that is to be provided as input to the action.; (xsd)requirement:DataRequirement>?
< Points to an existing input or output element that provides data to this input. The relatedData element allows indicating that an input to a parent action is an input to specific child actions. It also allows the output of one action to be identified as the input to a different action; (xsd)relatedData:id>?🔗 Defines the outputs of the action, if any.RequestOrchestration.action.output(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A human-readable label for the data requirement used to label data flows in BPMN or similar diagrams. Also provides a human readable label when rendering the data requirement that conveys its purpose to human readers.; (xsd)title:string>?
< Defines the data that results as output from the action.; (xsd)requirement:DataRequirement>?
< Points to an existing input or output element that is results as output from the action. The relatedData element allows indicating that the output of child action is also the output of a parent action. It also allows the input of one action to be identified as the output of a different action; (xsd)relatedData:string>?🔗 The participant that should perform or be responsible for this action. Because request orchestrations represent potential options for performing activities, some specific participants may still be unknown, so this element allows for both definitional participants (in the same way they are specified in ActivityDefinition and PlanDefinition resources) as well as identifying specific participants when they are known.RequestOrchestration.action.participant(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The type of participant in the action. Binding: action-participant-type (required, The type of participant in the activity.); (xsd)type:code>?
< The type of participant in the action.; (xsd)typeCanonical:CapabilityStatement*>?
< The type of participant in the action. When this element is a reference, it SHOULD be a reference to a definitional resource (for example, a location type, rather than a specific location).; (xsd)typeReference:(<CareTeam>
|<Device>
|<DeviceDefinition>
|<Endpoint>
|<Group>
|<HealthcareService>
|<Location>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>?
< The role the participant should play in performing the described action. Binding: http://terminology.hl7.org/ValueSet/action-participant-role (example, Defines roles played by participants for the action.); (xsd)role:CodeableConcept>?
< Indicates how the actor will be involved in the action - author, reviewer, witness, etc. Binding: action-participant-function (example, ); (xsd)function:CodeableConcept>?
< A reference to the actual participant.; (xsd)actor:(<CapabilityStatement>
|<CareTeam>
|<Device>
|<DeviceDefinition>
|<Endpoint>
|<Group>
|<HealthcareService>
|<Location>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>?🔗 A relationship to another action such as "before" or "30-60 minutes after start of".RequestOrchestration.action.relatedAction(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The element id of the target related action.; (xsd)targetId:id>
< The relationship of this action to the related action. Binding: action-relationship-type (required, Defines the types of relationships between actions.); (xsd)relationship:code>
< The relationship of the end of this action to the related action. Binding: action-relationship-type (required, Defines the types of relationships between actions.); (xsd)endRelationship:code>?
< A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.; (xsd)offset:(<Duration>
|<Range>)>?🔗 A set of requirements - a list of features or behaviors of designed systems that are necessary to achieve organizational or regulatory goals.Requirements(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< An absolute URI that is used to identify this Requirements when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this Requirements is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the Requirements is stored on different servers. Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.
The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions).
In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.; (xsd)url:uri>?
[]< A formal identifier that is used to identify this Requirements when it is represented in other formats, or referenced in a specification, model, design or an instance.; (xsd)identifier:Identifier>*
< The identifier that is used to identify this version of the Requirements when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the Requirements author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. There may be different Requirements instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the Requirements with the format [url]|[version]. The version SHOULD NOT contain a '#' - see [Business Version](resource.html#bv-format).; (xsd)version:string>?
< Indicates the mechanism used to compare versions to determine which is more current. If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined. Binding: version-algorithm (extensible, ); (xsd)versionAlgorithm:(<Coding>
|<string>)>?
< A natural language name identifying the Requirements. This name should be usable as an identifier for the module by machine processing applications such as code generation. The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.; (xsd)name:string>?
< A short, descriptive, user-friendly title for the Requirements. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.; (xsd)title:string>?
< The status of this Requirements. Enables tracking the life-cycle of the content. Allows filtering of Requirements that are appropriate for use versus not.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization). Binding: publication-status (required, The lifecycle status of an artifact.); (xsd)status:code>
< A Boolean value to indicate that this Requirements is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. Allows filtering of Requirements that are appropriate for use versus not.; (xsd)experimental:boolean>?
< The date (and optionally time) when the Requirements was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the Requirements changes. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the Requirements. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)date:dateTime>?
< The name of the organization or individual responsible for the release and ongoing maintenance of the Requirements. Usually an organization but may be an individual. The publisher (or steward) of the Requirements is the organization or individual primarily responsible for the maintenance and upkeep of the Requirements. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the Requirements. This item SHOULD be populated unless the information is available from context.; (xsd)publisher:string>?
[]< Contact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)contact:ContactDetail>*
< A free text natural language description of the requirements. This description can be used for a general description of the requirements, and which covers why it was defined.; (xsd)description:markdown>?
[]< The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate Requirements instances. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.; (xsd)useContext:UsageContext>*
[]< A legal or geographic region in which the Requirements is intended to be used. It may be possible for the Requirements to be used in jurisdictions other than those for which it was originally designed or intended
DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.). Binding: jurisdiction (extensible, Countries and regions within which this artifact is targeted for use.); (xsd)jurisdiction:CodeableConcept>*
< Explanation of why this Requirements is needed and why it has been designed as it has. This element does not describe the usage of the Requirements. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this Requirements.; (xsd)purpose:markdown>?
< A copyright statement relating to the Requirements and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the Requirements. ...; (xsd)copyright:markdown>?
< A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved'). The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.; (xsd)copyrightLabel:string>?
[]< Another set of Requirements that this set of Requirements builds on and updates. Existing statements (by key) may be narrowed or clarified, and additional statements added.; (xsd)derivedFrom:Requirements*>*
[]< A reference to another artifact that created this set of requirements. This could be a Profile, etc., or external regulation, or business requirements expressed elsewhere.; (xsd)reference:url>*
[]< An actor these requirements are in regard to. If more than one actor is specified, then it's up to the statements to describe in narrative if they don't apply to all actors.; (xsd)actor:ActorDefinition*>*
[]< The actual statement of requirement, in markdown format.; (xsd)statement:Requirements.statement>*🔗 The actual statement of requirement, in markdown format.Requirements.statement(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Key that identifies this statement (unique within this resource). Refer directly to the statement by {url}#{key}; (xsd)key:id>
< A short human usable label for this statement. The key is intended for computers, while this is intended for humans. In its absence, the key should be convenient for a human to say (e.g. not a UUID); (xsd)label:string>?
[]< A short human usable label for this statement. The conformance code is extracted from the requirement to make indexing and display easier. The requirement needs to express the conformance verbs directly in the markdown content. It's not unusual to mix verbs in a single sentence (e.g. System SHALL do X and SHOULD do Y) Binding: conformance-expectation (required, ); (xsd)conformance:code>*
< This boolean flag is set to true of the text of the requirement is conditional on something e.g. it includes lanauage like 'if x then y'. This conditionality flag is introduced for purposes of filtering and colour highlighting etc. There is no intent that the conditional statement by evaluatable; (xsd)conditionality:boolean>?
< The actual requirement for human consumption.; (xsd)requirement:markdown>
< Another statement on one of the requirements that this requirement clarifies or restricts. This can be just a key, if there is only one matching statement in the requirements statements referenced in Requirements.derivedFrom. If there is more than one, it should be in the format ```url#key```; (xsd)derivedFrom:string>?
< A larger requirement that this requirement helps to refine and enable. Follows the same convention as statement.derivedFrom, where a reference is the canonical of the Requirements followed by '#' and the 'key' of the specific requirement.; (xsd)parent:string>?
[]< A reference to another artifact that satisfies this requirement. This could be a Profile, extension, or an element in one of those, or a CapabilityStatement, OperationDefinition, SearchParameter, CodeSystem(/code), ValueSet, Libary etc. This is for use when the requirement is met be a pre-existing artifact e.g. a rule that's met by the base FHIR spec, or a national implementation guide.; (xsd)satisfiedBy:url>*
[]< A reference to another artifact that created this requirement. This could be a Profile, etc., or external regulation, or business requirements expressed elsewhere.; (xsd)reference:url>*
[]< Who asked for this statement to be a requirement. By default, it's assumed that the publisher knows who it is if it matters.; (xsd)source:(<CareTeam>
|<Device>
|<Group>
|<HealthcareService>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>*🔗 A scientific study of nature that sometimes includes processes involved in health and disease. For example, clinical trials are research studies that involve people. These studies may be related to new ways to screen, prevent, diagnose, and treat disease. They may also study certain outcomes and certain groups of people by looking at data collected in the past or future. Need to make sure we encompass public health studies.ResearchStudy(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< Canonical identifier for this study resource, represented as a globally unique URI.; (xsd)url:uri>?
[]< Identifiers assigned to this research study by the sponsor or other systems.; (xsd)identifier:Identifier>*
< The business version for the study record.; (xsd)version:string>?
< Name for this study (computer friendly).; (xsd)name:string>?
< The human readable name of the research study.; (xsd)title:string>?
[]< Additional names for the study.; (xsd)label:ResearchStudy.label>*
[]< The set of steps expected to be performed as part of the execution of the study.; (xsd)protocol:PlanDefinition*>*
[]< A larger research study of which this particular study is a component or step.; (xsd)partOf:ResearchStudy*>*
[]< Citations, references, URLs and other related documents. When using relatedArtifact to share URLs, the relatedArtifact.type will often be set to one of "documentation" or "supported-with" and the URL value will often be in relatedArtifact.document.url but another possible location is relatedArtifact.resource when it is a canonical URL.; (xsd)relatedArtifact:RelatedArtifact>*
< The date (and optionally time) when the ResearchStudy Resource was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the ResearchStudy Resource changes.; (xsd)date:dateTime>?
< The publication state of the resource (not of the study). Binding: publication-status (required, Codes that convey the current publication status of the research study resource.); (xsd)status:code>
< The type of study based upon the intent of the study activities. A classification of the intent of the study. Binding: research-study-prim-purp-type (preferred, Codes for the main intent of the study.); (xsd)primaryPurposeType:CodeableConcept>?
< The stage in the progression of a therapy from initial experimental use in humans in clinical trials to post-market evaluation. Binding: research-study-phase (example, Codes for the stage in the progression of a therapy from initial experimental use in humans in clinical trials to post-market evaluation.); (xsd)phase:CodeableConcept>?
[]< Codes categorizing the type of study such as investigational vs. observational, type of blinding, type of randomization, safety vs. efficacy, etc. Binding: study-design (preferred, This is a set of terms for study design characteristics.); (xsd)studyDesign:CodeableConcept>*
[]< The medication(s), food(s), therapy(ies), device(s) or other concerns or interventions that the study is seeking to gain more information about. Binding: research-study-focus-type (example, Common codes of research study focus); (xsd)focus:(<EvidenceVariable>
|<Medication>
|<MedicinalProductDefinition>
|<SubstanceDefinition>)>*
[]< The condition that is the focus of the study. For example, In a study to examine risk factors for Lupus, might have as an inclusion criterion "healthy volunteer", but the target condition code would be a Lupus SNOMED code. Binding: condition-code (example, Identification of the condition or diagnosis.); (xsd)condition:CodeableConcept>*
[]< Key terms to aid in searching for or filtering the study. Binding: (example, Words associated with the study that may be useful in discovery.); (xsd)keyword:CodeableConcept>*
[]< A country, state or other area where the study is taking place rather than its precise geographic location or address. Binding: jurisdiction (extensible, Countries and regions within which this artifact is targeted for use.); (xsd)region:CodeableConcept>*
< A brief text for explaining the study.; (xsd)descriptionSummary:markdown>?
< A detailed and human-readable narrative of the study. E.g., study abstract.; (xsd)description:markdown>?
< Identifies the start date and the expected (or actual, depending on status) end date for the study.; (xsd)period:Period>?
[]< A facility in which study activities are conducted.; (xsd)site:(<Location>
|<Organization>
|<ResearchStudy>)>*
[]< Comments made about the study by the performer, subject or other participants.; (xsd)note:Annotation>*
[]< Additional grouping mechanism or categorization of a research study. Example: FDA regulated device, FDA regulated drug, MPG Paragraph 23b (a German legal requirement), IRB-exempt, etc. Implementation Note: do not use the classifier element to support existing semantics that are already supported thru explicit elements in the resource. Binding: research-study-classifiers (example, desc.); (xsd)classifier:CodeableConcept>*
[]< Sponsors, collaborators, and other parties. For a Sponsor or a PrincipalInvestigator use the dedicated attributes provided.; (xsd)associatedParty:ResearchStudy.associatedParty>*
[]< Status of study with time for that status.; (xsd)progressStatus:ResearchStudy.progressStatus>*
< A description and/or code explaining the premature termination of the study. Binding: research-study-reason-stopped (example, Codes for why the study ended prematurely.); (xsd)whyStopped:CodeableConcept>?
< Target or actual group of participants enrolled in study.; (xsd)recruitment:ResearchStudy.recruitment>?
[]< Describes an expected event or sequence of events for one of the subjects of a study. E.g. for a living subject: exposure to drug A, wash-out, exposure to drug B, wash-out, follow-up. E.g. for a stability study: {store sample from lot A at 25 degrees for 1 month}, {store sample from lot A at 40 degrees for 1 month}. In many clinical trials this is refered to as the ARM of the study, but such a term is not used in other sorts of trials even when there is a comparison between two or more groups.; (xsd)comparisonGroup:ResearchStudy.comparisonGroup>*
[]< A goal that the study is aiming to achieve in terms of a scientific question to be answered by the analysis of data collected during the study.; (xsd)objective:ResearchStudy.objective>*
[]< An "outcome measure", "endpoint", "effect measure" or "measure of effect" is a specific measurement or observation used to quantify the effect of experimental variables on the participants in a study, or for observational studies, to describe patterns of diseases or traits or associations with exposures, risk factors or treatment. A study may have multiple distinct outcome measures that can be used to assess the overall goal for a study. The goal of a study is in the objective whereas the metric by which the goal is assessed is the outcomeMeasure. Examples: Time to Local Recurrence (TLR), Disease-free Survival (DFS), 30 Day Mortality, Systolic BP; (xsd)outcomeMeasure:ResearchStudy.outcomeMeasure>*
[]< Link to one or more sets of results generated by the study. Could also link to a research registry holding the results such as ClinicalTrials.gov.; (xsd)result:(<Citation>
|<DiagnosticReport>
|<EvidenceReport>)>*🔗 Sponsors, collaborators, and other parties. For a Sponsor or a PrincipalInvestigator use the dedicated attributes provided.ResearchStudy.associatedParty(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Name of associated party.; (xsd)name:string>?
< Type of association. Binding: research-study-party-role (extensible, desc.); (xsd)role:CodeableConcept>
[]< Identifies the start date and the end date of the associated party in the role. The cardinality is 0..* due to the fact that an associated party may be intermittently active in a given role over multiple time periods.; (xsd)period:Period>*
[]< A categorization other than role for the associated party. Binding: research-study-party-organization-type (example, A characterization or type of the entity.); (xsd)classifier:CodeableConcept>*
< Individual or organization associated with study (use practitionerRole to specify their organisation). Suggestions of a better attribute name are appreciated; (xsd)party:(<Organization>
|<Practitioner>
|<PractitionerRole>)>?🔗 Describes an expected event or sequence of events for one of the subjects of a study. E.g. for a living subject: exposure to drug A, wash-out, exposure to drug B, wash-out, follow-up. E.g. for a stability study: {store sample from lot A at 25 degrees for 1 month}, {store sample from lot A at 40 degrees for 1 month}. In many clinical trials this is refered to as the ARM of the study, but such a term is not used in other sorts of trials even when there is a comparison between two or more groups.ResearchStudy.comparisonGroup(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Allows the comparisonGroup for the study and the comparisonGroup for the subject to be linked easily.; (xsd)linkId:id>?
< Unique, human-readable label for this comparisonGroup of the study.; (xsd)name:string>
< Categorization of study comparisonGroup, e.g. experimental, active comparator, placebo comparater. Binding: research-study-arm-type (extensible, desc.); (xsd)type:CodeableConcept>?
< A succinct description of the path through the study that would be followed by a subject adhering to this comparisonGroup.; (xsd)description:markdown>?
[]< Interventions or exposures in this comparisonGroup or cohort.; (xsd)intendedExposure:EvidenceVariable*>*
< Group of participants who were enrolled in study comparisonGroup.; (xsd)observedGroup:Group*>?🔗 Additional names for the study.ResearchStudy.label(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Kind of name. Binding: title-type (extensible, desc.); (xsd)type:CodeableConcept>?
< The name.; (xsd)value:string>?🔗 A goal that the study is aiming to achieve in terms of a scientific question to be answered by the analysis of data collected during the study.ResearchStudy.objective(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Unique, human-readable label for this objective of the study.; (xsd)name:string>?
< The kind of study objective. Binding: research-study-objective-type (preferred, Codes for the kind of study objective.); (xsd)type:CodeableConcept>?
< Free text description of the objective of the study. This is what the study is trying to achieve rather than how it is going to achieve it (see ResearchStudy.description).; (xsd)description:markdown>?🔗 An "outcome measure", "endpoint", "effect measure" or "measure of effect" is a specific measurement or observation used to quantify the effect of experimental variables on the participants in a study, or for observational studies, to describe patterns of diseases or traits or associations with exposures, risk factors or treatment. A study may have multiple distinct outcome measures that can be used to assess the overall goal for a study. The goal of a study is in the objective whereas the metric by which the goal is assessed is the outcomeMeasure. Examples: Time to Local Recurrence (TLR), Disease-free Survival (DFS), 30 Day Mortality, Systolic BPResearchStudy.outcomeMeasure(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Label for the outcome.; (xsd)name:string>?
[]< The parameter or characteristic being assessed as one of the values by which the study is assessed. Binding: research-study-objective-type (preferred, defn.); (xsd)type:CodeableConcept>*
< Description of the outcome.; (xsd)description:markdown>?
< Structured outcome definition.; (xsd)reference:EvidenceVariable*>?🔗 Status of study with time for that status.ResearchStudy.progressStatus(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Label for status or state (e.g. recruitment status). Binding: research-study-status (extensible, defn.); (xsd)state:CodeableConcept>
< An indication of whether or not the date is a known date when the state changed or will change. A value of true indicates a known date. A value of false indicates an estimated date.; (xsd)actual:boolean>?
< Date range.; (xsd)period:Period>?🔗 Target or actual group of participants enrolled in study.ResearchStudy.recruitment(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Estimated total number of participants to be enrolled.; (xsd)targetNumber:unsignedInt>?
< Actual total number of participants enrolled in study.; (xsd)actualNumber:unsignedInt>?
< Inclusion and exclusion criteria.; (xsd)eligibility:(<EvidenceVariable>
|<Group>)>?
< Group of participants who were enrolled in study.; (xsd)actualGroup:Group*>?🔗 A ResearchSubject is a participant or object which is the recipient of investigative activities in a research study. Need to make sure we encompass public health studies.ResearchSubject(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< Identifiers assigned to this research subject for a study.; (xsd)identifier:Identifier>*
< The publication state of the resource (not of the subject). Binding: publication-status (required, Codes that convey the current publication status of the research study resource.); (xsd)status:code>
[]< The current state (status) of the subject and resons for status change where appropriate. This is intended to deal with the confusion routinely created by haing two conflated concepts of being in a particular state and having achieved a particular milestone. In strict terms a milestone is a point of time event that results in a change from one state to another. The state before the milestone is achieved is often given the same name as the milestone, and sometimes the state may have the same description. For instance "Randomised" and "Visit 1" may be different milestones but the state remains at "on study" after each of them.
It is likely that more than one "state" pattern will be recorded for a subject and a type has been introduced to allow this simultaneous recording.; (xsd)progress:ResearchSubject.progress>*
< The dates the subject began and ended their participation in the study.; (xsd)period:Period>?
< Reference to the study the subject is participating in.; (xsd)study:ResearchStudy*>
< The record of the person, animal or other entity involved in the study.; (xsd)subject:(<BiologicallyDerivedProduct>
|<Device>
|<Group>
|<Medication>
|<Patient>
|<Specimen>
|<Substance>)>
< The name of the arm in the study the subject is expected to follow as part of this study. Maybe this is really PlanDefinition.; (xsd)assignedComparisonGroup:id>?
< The name of the arm in the study the subject actually followed as part of this study.; (xsd)actualComparisonGroup:id>?
[]< A record of the patient's informed agreement to participate in the study.; (xsd)consent:Consent*>*🔗 The current state (status) of the subject and resons for status change where appropriate. This is intended to deal with the confusion routinely created by haing two conflated concepts of being in a particular state and having achieved a particular milestone. In strict terms a milestone is a point of time event that results in a change from one state to another. The state before the milestone is achieved is often given the same name as the milestone, and sometimes the state may have the same description. For instance "Randomised" and "Visit 1" may be different milestones but the state remains at "on study" after each of them.
It is likely that more than one "state" pattern will be recorded for a subject and a type has been introduced to allow this simultaneous recording.ResearchSubject.progress(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Identifies the aspect of the subject's journey that the state refers to. Binding: research-subject-state-type (example, Identifies the kind of state being refered to.); (xsd)type:CodeableConcept>?
< The current state of the subject. Binding: research-subject-state (required, Indicates the progression of a study subject through a study.); (xsd)subjectState:CodeableConcept>?
< The milestones the subject has passed through. There can be multiple entries but it is also valid to just have the most recent. This should npt be rlied upon as the full path the subject has taken. Binding: research-subject-milestone (example, Indicates the progression of a study subject through the study milestones.); (xsd)milestone:CodeableConcept>?
< The reason for the state change. If coded it should follow the formal subject state model. Binding: http://terminology.hl7.org/ValueSet/state-change-reason (example, Indicates why the state of the subject changed.); (xsd)reason:CodeableConcept>?
< The date when the new status started. This is NOT the date the change in state was recorded.; (xsd)startDate:dateTime>?
< The date when the state ended.; (xsd)endDate:dateTime>?🔗 This is the base resource type for everything.Resource(xsd)(doc)=
<#base:Base>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?🔗 This profile defines how to represent Respiratory Rate observations in FHIR using a standard LOINC code and UCUM units of measure. Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as laboratory reports, etc.resprate(xsd)(doc)=
<#base:vitalsigns>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< A unique identifier assigned to this observation.; (xsd)identifier:Identifier>*
< The reference to a FHIR ObservationDefinition resource that provides the definition that is adhered to in whole or in part by this Observation instance. ObservationDefinition can be referenced by its canonical url using instantiatesCanonical, or by a name or an identifier using the appropriate sub-elements of instantiatesReference.; (xsd)instantiates:ObservationDefinition*>?
[]< A plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed.; (xsd)basedOn:(<CarePlan>
|<DeviceRequest>
|<ImmunizationRecommendation>
|<MedicationRequest>
|<NutritionOrder>
|<ServiceRequest>)>*
[]< Identifies the observation(s) that triggered the performance of this observation.; (xsd)triggeredBy:resprate.triggeredBy>*
[]< A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure. To link an Observation to an Encounter use `encounter`. See the [Notes](observation.html#obsgrouping) below for guidance on referencing another Observation.; (xsd)partOf:(<GenomicStudy>
|<ImagingStudy>
|<Immunization>
|<MedicationAdministration>
|<MedicationDispense>
|<MedicationStatement>
|<Procedure>)>*
< The status of the result value. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. Binding: observation-status (required, ); (xsd)status:code>
[]< A code that classifies the general type of observation being made. In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set. Binding: observation-category (preferred, Codes for high level observation categories.); (xsd)category:CodeableConcept>+
< Respiratory Rate. additional codes that translate or map to this code are allowed. For example a more granular LOINC code or code that is used locally in a system. Binding: observation-vitalsignresult (extensible, This identifies the vital sign result type. Original source C-CDA R1.1 , HITSP Vital Sign Result Type.); (xsd)code:resprate.code>
< The patient, or group of patients, location, device, organization, procedure or practitioner this observation is about and into whose or what record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the `focus` element or the `code` itself specifies the actual focus of the observation. One would expect this element to be a cardinality of 1..1. The only circumstance in which the subject can be missing is when the observation is made by a device that does not know the patient. In this case, the observation SHALL be matched to a patient through some context/channel matching technique, and at this point, the observation should be updated. The subject of an Observation may in some cases be a procedure. This supports the regulatory inspection use case where observations are captured during inspections of a procedure that is being performed (independent of any particular patient or whether patient related at all).; (xsd)subject:Patient*>
[]< The actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also be an existing condition, an intervention, the subject's diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child's tracheostomy tube. In this example, the child is the patient of record and the mother is the focus. Typically, an observation is made about the subject - a patient, or group of patients, location, or device - and the distinction between the subject and what is directly measured for an observation is specified in the observation code itself ( e.g., "Blood Glucose") and does not need to be represented separately using this element. Use `specimen` if a reference to a specimen is required. If a code is required instead of a resource use either `bodysite` for bodysites or the standard extension [http://hl7.org/fhir/StructureDefinition/observation-focusCode](http://hl7.org/fhir/extensions/StructureDefinition-observation-focusCode.html).; (xsd)focus:Resource*>*
< The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made. This will typically be the encounter the event occurred within, but some events may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission laboratory tests).; (xsd)encounter:Encounter*>?
< Often just a dateTime for Vital Signs. At least a date should be present unless this observation is a historical report. For recording imprecise or "fuzzy" times (For example, a blood glucose measurement taken "after breakfast") use the [Timing](datatypes.html#timing) datatype which allow the measurement to be tied to regular life events.; (xsd)effective:(<dateTime>
|<Period>)>
< The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified. For Observations that don't require review and verification, it may be the same as the [`lastUpdated` ](resource-definitions.html#Meta.lastUpdated) time of the resource itself. For Observations that do require review and verification for certain updates, it might not be the same as the `lastUpdated` time of the resource itself due to a non-clinically significant update that doesn't require the new version to be reviewed and verified again.; (xsd)issued:instant>?
[]< Who was responsible for asserting the observed value as "true".; (xsd)performer:(<CareTeam>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>*
(<valueAttachment:Attachment>
|<valueBoolean:boolean>
|<valueCodeableConcept:CodeableConcept>
|<valueDateTime:dateTime>
|<valueInteger:integer>
|<valueMolecularSequence:MolecularSequence>
|<valuePeriod:Period>
|<valueQuantity:Quantity>
|<valueRange:Range>
|<valueRatio:Ratio>
|<valueSampledData:SampledData>
|<valueString:string>
|<valueTime:time>)?
< Provides a reason why the expected value in the element Observation.value[x] is missing. Null or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be "detected", "not detected", "inconclusive", or "specimen unsatisfactory".
The alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code "error" could be used when the measurement was not completed. Note that an observation may only be reported if there are values to report. For example differential cell counts values may be reported only when > 0. Because of these options, use-case agreements are required to interpret general observations for null or exceptional values. Binding: data-absent-reason (extensible, Codes specifying why the result (`Observation.value[x]`) is missing.); (xsd)dataAbsentReason:CodeableConcept>?
[]< A categorical assessment of an observation value. For example, high, low, normal. Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Binding: observation-interpretation (extensible, Codes identifying interpretations of observations.); (xsd)interpretation:CodeableConcept>*
[]< Comments about the observation or the results. May include general statements about the observation, or statements about significant, unexpected or unreliable results values, or information about its source when relevant to its interpretation.; (xsd)note:Annotation>*
< Indicates the site on the subject's body where the observation was made (i.e. the target site). Only used if not implicit in code found in Observation.code. In many systems, this may be represented as a related observation instead of an inline component. Binding: body-site (example, SNOMED CT Body site concepts); (xsd)bodySite:CodeableConcept>?
< Indicates the body structure on the subject's body where the observation was made (i.e. the target site). Only used if not implicit in code found in Observation.code or bodySite is used. In many systems, this may be represented as a related observation instead of an inline component.; (xsd)bodyStructure:BodyStructure*>?
< Indicates the mechanism used to perform the observation. Only used if not implicit in code for Observation.code. Binding: observation-methods (example, Methods for simple observations.); (xsd)method:CodeableConcept>?
< The specimen that was used when this observation was made. Should only be used if not implicit in code found in `Observation.code`. Observations are not made on specimens themselves; they are made on a subject, but in many cases by the means of a specimen. Note that although specimens are often involved, they are not always tracked and reported explicitly. Also note that observation resources may be used in contexts that track the specimen explicitly (e.g. Diagnostic Report).; (xsd)specimen:(<Group>
|<Specimen>)>?
< A reference to the device that generates the measurements or the device settings for the device. Note that this is not meant to represent a device involved in the transmission of the result, e.g., a gateway. Such devices may be documented using the Provenance resource where relevant.; (xsd)device:(<Device>
|<DeviceMetric>)>?
[]< Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an "OR". In other words, to represent two distinct target populations, two `referenceRange` elements would be used. Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.; (xsd)referenceRange:resprate.referenceRange>*
[]< Used when reporting vital signs panel components. When using this element, an observation will typically have either a value or a set of related resources, although both may be present in some cases. For a discussion on the ways Observations can assembled in groups together, see [Notes](observation.html#obsgrouping) below. Note that a system may calculate results from [QuestionnaireResponse](questionnaireresponse.html) into a final score and represent the score as an Observation.; (xsd)hasMember:(<MolecularSequence>
|<QuestionnaireResponse>
|<vitalsigns>)>*
[]< The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image. All the reference choices that are listed in this element can represent clinical observations and other measurements that may be the source for a derived value. The most common reference will be another Observation. For a discussion on the ways Observations can assembled in groups together, see [Notes](observation.html#obsgrouping) below.; (xsd)derivedFrom:(<DocumentReference>
|<ImagingStudy>
|<MolecularSequence>
|<QuestionnaireResponse>
|<vitalsigns>)>*
[]< Used when reporting systolic and diastolic blood pressure. For a discussion on the ways Observations can be assembled in groups together see [Notes](observation.html#notes) below.; (xsd)component:resprate.component>*
< A code that classifies the general type of observation being made. In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set. Binding: observation-category (preferred, Codes for high level observation categories.); (xsd)VSCat:resprate.VSCat>
< Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept. - An observation may have:
1. a single value here
1. both a value and a set of related or component values
1. only a set of related or component values.
- If a value is present, the datatype for this element should be determined by the `code`.
- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.
- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.
- The usage of valueReference is restricted to the MolecularSequence resource when used as a definitional resource, not as a patient-specific finding. .
- For additional guidance, see the [Notes section](observation.html#notes) below.; (xsd)valueQuantity:resprate.valueQuantity>?🔗 Respiratory Rate. additional codes that translate or map to this code are allowed. For example a more granular LOINC code or code that is used locally in a system. Binding: observation-vitalsignresult (extensible, This identifies the vital sign result type. Original source C-CDA R1.1 , HITSP Vital Sign Result Type.)resprate.code(xsd)(doc)=
<#base:CodeableConcept>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< 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.; (xsd)coding:Coding>*
< 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.; (xsd)text:string>?
< 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.; (xsd)RespRateCode:resprate.code.RespRateCode>🔗 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.resprate.code.RespRateCode(xsd)(doc)=
<#base:Coding>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< 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 be an absolute reference to some definition that establishes the system clearly and unambiguously. http://loinc.org; (xsd)system:uri>
< 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.; (xsd)version:string>?
< 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). 9279-1; (xsd)code>
< A representation of the meaning of the code in the system, following the rules of the system.; (xsd)display:string>?
< 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.; (xsd)userSelected:boolean>?🔗 Used when reporting systolic and diastolic blood pressure. For a discussion on the ways Observations can be assembled in groups together see [Notes](observation.html#notes) below.resprate.component(xsd)(doc)=
<#base:Observation.component>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Describes what was observed. Sometimes this is called the observation "code". *All* code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. Binding: observation-vitalsignresult (extensible, This identifies the vital sign result type. Original source C-CDA R1.1 , HITSP Vital Sign Result Type.); (xsd)code:CodeableConcept>
(<valueAttachment:Attachment>
|<valueBoolean:boolean>
|<valueCodeableConcept:CodeableConcept>
|<valueDateTime:dateTime>
|<valueInteger:integer>
|<valueMolecularSequence:MolecularSequence>
|<valuePeriod:Period>
|<valueQuantity:Quantity>
|<valueRange:Range>
|<valueRatio:Ratio>
|<valueSampledData:SampledData>
|<valueString:string>
|<valueTime:time>)?
< Provides a reason why the expected value in the element Observation.component.value[x] is missing. "Null" or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be "detected", "not detected", "inconclusive", or "test not done".
The alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code "error" could be used when the measurement was not completed. Because of these options, use-case agreements are required to interpret general observations for exceptional values. Binding: data-absent-reason (extensible, Codes specifying why the result (`Observation.value[x]`) is missing.); (xsd)dataAbsentReason:CodeableConcept>?
[]< A categorical assessment of an observation value. For example, high, low, normal. Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Binding: observation-interpretation (extensible, Codes identifying interpretations of observations.); (xsd)interpretation:CodeableConcept>*
[]< Guidance on how to interpret the value by comparison to a normal or recommended range. Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.; (xsd)referenceRange:Observation.referenceRange>*
< Vital Sign Value recorded with UCUM. Used when observation has a set of component observations:
- An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was derived).
- If a value is present, the datatype for this element should be determined by the `code`.
- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.
- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.
- If a value is present, the datatype for this element should be determined by the `code`.
- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.
- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.
- The usage of valueReference is restricted to the MolecularSequence resource when used as a definitional resource, not as a patient-specific finding. .
- For additional guidance, see the [Notes section](observation.html#notes) below. Binding: ucum-vitals-common (required, Commonly encountered UCUM units for recording Vital Signs.); (xsd)valueQuantity:Quantity>?🔗 Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an "OR". In other words, to represent two distinct target populations, two `referenceRange` elements would be used. Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.resprate.referenceRange(xsd)(doc)=
<#base:Observation.referenceRange>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The value of the low bound of the reference range. The low bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the low bound is omitted, it is assumed to be meaningless (e.g. reference range is <=2.3).; (xsd)low:SimpleQuantity>?
< The value of the high bound of the reference range. The high bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the high bound is omitted, it is assumed to be meaningless (e.g. reference range is >= 2.3).; (xsd)high:SimpleQuantity>?
< The value of the normal value of the reference range. Binding: observation-referencerange-normalvalue (extensible, Codes identifying the normal value of the observation.); (xsd)normalValue:CodeableConcept>?
< Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range. This SHOULD be populated if there is more than one range. If this element is not present then the normal range is assumed. Binding: referencerange-meaning (preferred, Code for the meaning of a reference range.); (xsd)type:CodeableConcept>?
[]< Codes to indicate the target population this reference range applies to. For example, a reference range may be based on the normal population or a particular sex or race. Multiple `appliesTo` are interpreted as an "AND" of the target populations. For example, to represent a target population of African American females, both a code of female and a code for African American would be used. This SHOULD be populated if there is more than one range. If this element is not present then the normal population is assumed. Binding: referencerange-appliesto (example, Codes identifying the population the reference range applies to.); (xsd)appliesTo:CodeableConcept>*
< The age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so.; (xsd)age:Range>?
< Text based reference range in an observation which may be used when a quantitative range is not appropriate for an observation. An example would be a reference value of "Negative" or a list or table of "normals".; (xsd)text:markdown>?🔗 Identifies the observation(s) that triggered the performance of this observation.resprate.triggeredBy(xsd)(doc)=
<#base:Observation.triggeredBy>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Reference to the triggering observation.; (xsd)observation:Observation*>
< The type of trigger.
Reflex | Repeat | Re-run. Binding: observation-triggeredbytype (required, The type of TriggeredBy Observation.); (xsd)type:code>
< Provides the reason why this observation was performed as a result of the observation(s) referenced.; (xsd)reason:string>?🔗 Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept. - An observation may have:
1. a single value here
1. both a value and a set of related or component values
1. only a set of related or component values.
- If a value is present, the datatype for this element should be determined by the `code`.
- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.
- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.
- The usage of valueReference is restricted to the MolecularSequence resource when used as a definitional resource, not as a patient-specific finding. .
- For additional guidance, see the [Notes section](observation.html#notes) below.resprate.valueQuantity(xsd)(doc)=
<#base:Quantity>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< 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).; (xsd)value:decimal>
< 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. Binding: quantity-comparator (required, How the Quantity should be understood and represented.); (xsd)comparator:code>?
< A human-readable form of the unit.; (xsd)unit:string>
< The identification of the system that provides the coded form of the unit. http://unitsofmeasure.org; (xsd)system:uri>
< Coded responses from the common UCUM units for vital signs value set. 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. /min; (xsd)code>🔗 A code that classifies the general type of observation being made. In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set. Binding: observation-category (preferred, Codes for high level observation categories.)resprate.VSCat(xsd)(doc)=
<#base:vitalsigns.VSCat>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< 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.; (xsd)coding:resprate.VSCat.coding>+
< 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.; (xsd)text:string>?🔗 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.resprate.VSCat.coding(xsd)(doc)=
<#base:vitalsigns.VSCat.coding>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< 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 be an absolute reference to some definition that establishes the system clearly and unambiguously. http://terminology.hl7.org/CodeSystem/observation-category; (xsd)system:uri>
< 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.; (xsd)version:string>?
< 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). vital-signs; (xsd)code>
< A representation of the meaning of the code in the system, following the rules of the system.; (xsd)display:string>?
< 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.; (xsd)userSelected:boolean>?🔗 An ExtensionResultInterpretationSummary(xsd)(doc)=
<#base:Extension>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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. http://hl7.org/fhir/uv/order-catalog/StructureDefinition/ResultInterpretationSummary; (xsd)url:string>
< Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R5/extensibility.html) for a list).; (xsd)value:markdown>?🔗 An assessment of the likely outcome(s) for a patient or other subject as well as the likelihood of each outcome.RiskAssessment(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< Business identifier assigned to the risk assessment.; (xsd)identifier:Identifier>*
< A reference to the request that is fulfilled by this risk assessment.; (xsd)basedOn:Resource*>?
< A reference to a resource that this risk assessment is part of, such as a Procedure.; (xsd)parent:Resource*>?
< The status of the RiskAssessment, using the same statuses as an Observation. Binding: observation-status (required, The status of the risk assessment; e.g. preliminary, final, amended, etc.); (xsd)status:code>
< The algorithm, process or mechanism used to evaluate the risk. Binding: (example, The mechanism or algorithm used to make the assessment; e.g. TIMI, PRISM, Cardiff Type 2 diabetes, etc.); (xsd)method:CodeableConcept>?
< The type of the risk assessment performed.; (xsd)code:CodeableConcept>?
< The patient or group the risk assessment applies to.; (xsd)subject:(<Group>
|<Patient>)>
< The encounter where the assessment was performed.; (xsd)encounter:Encounter*>?
< The date (and possibly time) the risk assessment was performed.; (xsd)occurrence:(<dateTime>
|<Period>)>?
< For assessments or prognosis specific to a particular condition, indicates the condition being assessed.; (xsd)condition:Condition*>?
< The provider, patient, related person, or software application that performed the assessment.; (xsd)performer:(<Device>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>?
[]< The reason the risk assessment was performed.; (xsd)reason:(<Condition>
|<DiagnosticReport>
|<DocumentReference>
|<Observation>)>*
[]< Indicates the source data considered as part of the assessment (for example, FamilyHistory, Observations, Procedures, Conditions, etc.).; (xsd)basis:Resource*>*
[]< Describes the expected outcome for the subject. Multiple repetitions can be used to identify the same type of outcome in different timeframes as well as different types of outcomes.; (xsd)prediction:RiskAssessment.prediction>*
< A description of the steps that might be taken to reduce the identified risk(s).; (xsd)mitigation:string>?
[]< Additional comments about the risk assessment.; (xsd)note:Annotation>*🔗 Describes the expected outcome for the subject. Multiple repetitions can be used to identify the same type of outcome in different timeframes as well as different types of outcomes.RiskAssessment.prediction(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< One of the potential outcomes for the patient (e.g. remission, death, a particular condition). Binding: (example, The condition or other outcome; e.g. death, remission, amputation, infection, etc.); (xsd)outcome:CodeableConcept>?
< Indicates how likely the outcome is (in the specified timeframe). If range is used, it represents the lower and upper bounds of certainty; e.g. 40-60% Decimal values are expressed as percentages as well (max = 100).; (xsd)probability:(<decimal>
|<Range>)>?
< Indicates how likely the outcome is (in the specified timeframe), expressed as a qualitative value (e.g. low, medium, or high). Binding: risk-probability (example, The likelihood of the occurrence of a specified outcome.); (xsd)qualitativeRisk:CodeableConcept>?
< Indicates the risk for this particular subject (with their specific characteristics) divided by the risk of the population in general. (Numbers greater than 1 = higher risk than the population, numbers less than 1 = lower risk.).; (xsd)relativeRisk:decimal>?
< Indicates the period of time or age range of the subject to which the specified probability applies. If not specified, the risk applies "over the subject's lifespan".; (xsd)when:(<Period>
|<Range>)>?
< Additional information explaining the basis for the prediction.; (xsd)rationale:string>?🔗 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(xsd)(doc)=
<#base:DataType>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< The base quantity that a measured value of zero represents. In addition, this provides the units of the entire measurement series.; (xsd)origin:SimpleQuantity>
< Amount of intervalUnits between samples, e.g. milliseconds for time-based sampling. This is usually a whole number.; (xsd)interval:decimal>?
< The measurement unit in which the sample interval is expressed. Binding: ucum-units (required, Units of measure allowed for an element.); (xsd)intervalUnit:code>
< A correction factor that is applied to the sampled data points before they are added to the origin.; (xsd)factor:decimal>?
< 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).; (xsd)lowerLimit:decimal>?
< 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).; (xsd)upperLimit:decimal>?
< 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).; (xsd)dimensions:positiveInt>
< Reference to ConceptMap that defines the codes used in the data. The ConceptMap cannot define meanings for the codes 'E', 'U', or 'L' (nor 'e', 'u', or 'l').; (xsd)codeMap:ConceptMap*>?
< A series of data points which are decimal values separated by a single space (character u20). The units in which the offsets are expressed are found in intervalUnit. The absolute point at which the measurements begin SHALL be conveyed outside the scope of this datatype, e.g. Observation.effectiveDateTime for a timing offset. If offsets is present, the number of data points must be equal to the number of offsets mlutipled by the dimensions.; (xsd)offsets:string>?
< A series of data points which are decimal values or codes separated by a single space (character u20). The special codes "E" (error), "L" (below detection limit) and "U" (above detection limit) are also defined for used in place of decimal values. The data may be missing if it is omitted for summarization purposes. In general, data is required for any actual use of a SampledData.; (xsd)data:string>?🔗 A search parameter that defines a named search item that can be used to search/filter on a resource. In FHIR, search is not performed directly on a resource (by XML or JSON path), but on a named parameter that maps into the resource content.SearchParameter(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< An absolute URI that is used to identify this search parameter when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this search parameter is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the search parameter is stored on different servers. Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.
The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions).
In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.; (xsd)url:uri>
[]< A formal identifier that is used to identify this search parameter when it is represented in other formats, or referenced in a specification, model, design or an instance.; (xsd)identifier:Identifier>*
< The identifier that is used to identify this version of the search parameter when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the search parameter author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. There may be different search parameter instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the search parameter with the format [url]|[version]. The version SHOULD NOT contain a '#' - see [Business Version](resource.html#bv-format).; (xsd)version:string>?
< Indicates the mechanism used to compare versions to determine which is more current. If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined. Binding: version-algorithm (extensible, ); (xsd)versionAlgorithm:(<Coding>
|<string>)>?
< A natural language name identifying the search parameter. This name should be usable as an identifier for the module by machine processing applications such as code generation. The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.; (xsd)name:string>
< A short, descriptive, user-friendly title for the search parameter. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.; (xsd)title:string>?
< Where this search parameter is originally defined. If a derivedFrom is provided, then the details in the search parameter must be consistent with the definition from which it is defined. i.e. the parameter should have the same meaning, and (usually) the functionality should be a proper subset of the underlying search parameter. The intent of this is that a server can designate that it provides support for a search parameter defined in the specification itself (e.g. [`value-quantity`](http://hl7.org/fhir/SearchParameter/Observation-value-quantity), but detail how it is supported by the server.; (xsd)derivedFrom:SearchParameter*>?
< The status of this search parameter. Enables tracking the life-cycle of the content. Allows filtering of search parameters that are appropriate for use versus not.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization). Binding: publication-status (required, The lifecycle status of an artifact.); (xsd)status:code>
< A Boolean value to indicate that this search parameter is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. Allows filtering of search parameters that are appropriate for use versus not.; (xsd)experimental:boolean>?
< The date (and optionally time) when the search parameter was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the search parameter changes. The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the search parameter. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)date:dateTime>?
< The name of the organization or individual tresponsible for the release and ongoing maintenance of the search parameter. Usually an organization but may be an individual. The publisher (or steward) of the search parameter is the organization or individual primarily responsible for the maintenance and upkeep of the search parameter. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the search parameter. This item SHOULD be populated unless the information is available from context.; (xsd)publisher:string>?
[]< Contact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)contact:ContactDetail>*
< And how it used. This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the search parameter as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the search parameter is presumed to be the predominant language in the place the search parameter was created).; (xsd)description:markdown>
[]< The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate search parameter instances. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.; (xsd)useContext:UsageContext>*
[]< A legal or geographic region in which the search parameter is intended to be used. It may be possible for the search parameter to be used in jurisdictions other than those for which it was originally designed or intended.
DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.) Binding: jurisdiction (extensible, Countries and regions within which this artifact is targeted for use.); (xsd)jurisdiction:CodeableConcept>*
< Explanation of why this search parameter is needed and why it has been designed as it has. This element does not describe the usage of the search parameter. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this search parameter.; (xsd)purpose:markdown>?
< A copyright statement relating to the search parameter and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the search parameter. ...; (xsd)copyright:markdown>?
< A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved'). The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.; (xsd)copyrightLabel:string>?
< The label that is recommended to be used in the URL or the parameter name in a parameters resource for this search parameter. In some cases, servers may need to use a different CapabilityStatement searchParam.name to differentiate between multiple SearchParameters that happen to have the same code. For maximum compatibility, use only lowercase ASCII characters. Note that HL7 will never define multiple search parameters with the same code.; (xsd)code>
[]< The base resource type(s) that this search parameter can be used against. A search parameter must always apply to at least one resource type. When search parameters apply to more than one resource type, they can be used against any of the listed resource types, or in a cross-type search (see [Cross Resource Search](http.html#xres-search)). Binding: version-independent-all-resource-types (required, A type of resource, or a Reference (from all versions)); (xsd)base:code>+
< The type of value that a search parameter may contain, and how the content is interpreted. Binding: search-param-type (required, Data types allowed to be used for search parameters.); (xsd)type:code>
< A FHIRPath expression that returns a set of elements for the search parameter. Note that the elements returned by the expression are sometimes complex elements where logic is required to determine quite how to handle them; e.g. CodeableConcepts may contain text and/or multiple codings, where the codings themselves contain a code and a system. For composite search parameters, the outcome of the expression must a collection of base elements from which the composites are derived.; (xsd)expression:string>?
< How the search parameter relates to the set of elements returned by evaluating the expression query. Binding: search-processingmode (required, How a search parameter relates to the set of elements returned by evaluating its expression query.); (xsd)processingMode:code>?
< FHIRPath expression that defines/sets a complex constraint for when this SearchParameter is applicable.; (xsd)constraint:string>?
[]< Types of resource (if a resource is referenced). In some cases, targets may exist for a search parameter that do not exist for the specified FHIRPath for all of the resources identified in SearchParameter.base. For example, the core clinical-encounter search parameter allows both Encounter and EpisodeOfCare as targets, even though not all of the base resources have EpisodeOfCare as a valid target.
However, the list of targets SHOULD cover all targets that might appear that are permitted by the specified FHIRPath. Binding: version-independent-all-resource-types (required, A type of resource, or a Reference (from all versions)); (xsd)target:code>*
< Whether multiple values are allowed for each time the parameter exists. Values are separated by commas, and the parameter matches if any of the values match.; (xsd)multipleOr:boolean>?
< Whether multiple parameters are allowed - e.g. more than one parameter with the same name. The search matches if all the parameters match.; (xsd)multipleAnd:boolean>?
[]< Comparators supported for the search parameter. If no comparators are listed, clients should not expect servers to support any comparators. Binding: search-comparator (required, What Search Comparator Codes are supported in search.); (xsd)comparator:code>*
[]< A modifier supported for the search parameter. Binding: search-modifier-code (required, A supported modifier for a search parameter.); (xsd)modifier:code>*
[]< Contains the names of any search parameters which may be chained to the containing search parameter. Chained parameters may be added to search parameters of type reference and specify that resources will only be returned if they contain a reference to a resource which matches the chained parameter value. Values for this field should be drawn from SearchParameter.code for a parameter on the target resource type. Notes:
* Not all systems will declare chain values. If no chain values are specified at all, then no presumptions can be made about the degree of chaining support available
* A server may use a single chain value of '*' to mean that all reference search types supported can be chained rather than enumerating all chain values
* If a particular reference search parameter is supported, but not subsequent chaining, then just list that search parameter name - e.g. for Patient.practitioner, the chain value would be ```practitioner```
* If a particular reference search parameter is supported with unlimited chaining beneath it, then follow the search parameter name with '.'. E.g. ```practitioner.```
* If there are specific (not unlimited) chaining paths allowed they can be explicitly enumerated. E.g. ```practitioner.organization```; (xsd)chain:string>*
[]< Used to define the parts of a composite search parameter.; (xsd)component:SearchParameter.component>*🔗 Used to define the parts of a composite search parameter.SearchParameter.component(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The definition of the search parameter that describes this part.; (xsd)definition:SearchParameter*>
< A sub-expression that defines how to extract values for this component from the output of the main SearchParameter.expression. This expression overrides the expression in the definition and extracts the index values from the outcome of the composite expression.; (xsd)expression:string>🔗 A container for a collection of resources.search-set-bundle(xsd)(doc)=
<#base:Bundle>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< A persistent identifier for the bundle that won't change as a bundle is copied from server to server. Persistent identity generally only matters for batches of type Document, Message, and Collection. It would not normally be populated for search and history results and servers ignore Bundle.identifier when processing batches and transactions. For Documents the .identifier SHALL be populated such that the .identifier is globally unique.; (xsd)identifier:Identifier>?
< Indicates the purpose of this bundle - how it is intended to be used. It's possible to use a bundle for other purposes (e.g. a document can be accepted as a transaction). This is primarily defined so that there can be specific rules for some of the bundle types. Binding: bundle-type (required, Indicates the purpose of a bundle - how it is intended to be used.); (xsd)type:code>
< The date/time that the bundle was assembled - i.e. when the resources were placed in the bundle. For many bundles, the timestamp is equal to .meta.lastUpdated, because they are not stored (e.g. search results). When a bundle is placed in a persistent store, .meta.lastUpdated will be usually be changed by the server. When the bundle is a message, a middleware agent altering the message (even if not stored) SHOULD update .meta.lastUpdated. .timestamp is used to track the original time of the Bundle, and SHOULD be populated.
Usage:
* document : the date the document was created. Note: the composition may predate the document, or be associated with multiple documents. The date of the composition - the authoring time - may be earlier than the document assembly time
* message : the date that the content of the message was assembled. This date is not changed by middleware engines unless they add additional data that changes the meaning of the time of the message
* history : the date that the history was assembled. This time would be used as the _since time to ask for subsequent updates
* searchset : the time that the search set was assembled. Note that different pages MAY have different timestamps but need not. Having different timestamps does not imply that subsequent pages will represent or include changes made since the initial query
* transaction | transaction-response | batch | batch-response | collection : no particular assigned meaning
The timestamp value should be greater than the lastUpdated and other timestamps in the resources in the bundle, and it should be equal or earlier than the .meta.lastUpdated on the Bundle itself.; (xsd)timestamp:instant>?
< If a set of search matches, this is the (potentially estimated) total number of entries of type 'match' across all pages in the search. It does not include search.mode = 'include' or 'outcome' entries and it does not provide a count of the number of entries in the Bundle. Only used if the bundle is a search result set. The total does not include resources such as OperationOutcome and included resources, only the total number of matching resources.; (xsd)total:unsignedInt>?
[]< A series of links that provide context to this bundle. Both Bundle.link and Bundle.entry.link are defined to support providing additional context when Bundles are used (e.g. [HATEOAS](http://en.wikipedia.org/wiki/HATEOAS)).
Bundle.entry.link corresponds to links found in the HTTP header if the resource in the entry was [read](http.html#read) directly.
This specification defines some specific uses of Bundle.link for [searching](search.html#conformance) and [paging](http.html#paging), but no specific uses for Bundle.entry.link, and no defined function in a transaction - the meaning is implementation specific. The behavior of navigation link types (next/prev/first/last) are well defined for searchset and history Bundles but are not currently defined for other types. Implementers who choose to use such link relationships for other bundle types will need to negotiate behavior with their interoperability partners.; (xsd)link:search-set-bundle.link>*
[]< An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).; (xsd)entry:search-set-bundle.entry>*
< Digital Signature - base64 encoded. XML-DSig or a JWS. The signature could be created by the "author" of the bundle or by the originating device. Requirements around inclusion of a signature, verification of signatures and treatment of signed/non-signed bundles is implementation-environment specific.; (xsd)signature:Signature>?
< Captures issues and warnings that relate to the construction of the Bundle and the content within it. Usage notes: These issues and warnings must apply to the Bundle as a whole, not to individual entries.Messages relating to the processing of individual entries (e.g. in a batch or transaction) SHALL be reported in the entry.response.outcome for that entry. If there are errors that arise in the creation of the Bundle, then that should be handled by an OperationOutcome being returned instead of the Bundle.; (xsd)issues:OperationOutcome>?
< An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).; (xsd)operationOutcome:search-set-bundle.operationOutcome>?
[]< An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).; (xsd)other:search-set-bundle.other>*🔗 An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).search-set-bundle.entry(xsd)(doc)=
<#base:Bundle.entry>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< A series of links that provide context to this entry.; (xsd)link:Bundle.link>*
< The Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when:
* invoking a create
* invoking or responding to an operation where the body is not a single identified resource
* invoking or returning the results of a search or history operation. fullUrl might not be [unique in the context of a resource](bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](references.html), the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the [regex](references.html#regex), then the 'id' portion of the fullUrl SHALL end with the Resource.id.
Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).; (xsd)fullUrl:uri>?
< The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. This is allowed to be a Parameters resource if and only if it is referenced by something else within the Bundle that provides context/meaning.; (xsd)resource:Resource>?
< Information about the search process that lead to the creation of this entry.; (xsd)search:search-set-bundle.entry.search>?
< Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.; (xsd)request:search-set-bundle.entry.request>?
< Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.; (xsd)response:search-set-bundle.entry.response>?🔗 Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.search-set-bundle.entry.request(xsd)(doc)=
<#base:Bundle.entry.request>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred. Binding: http-verb (required, HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details.); (xsd)method:code>
< The URL for this entry, relative to the root (the address to which the request is posted). E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]".; (xsd)url:uri>
< If the ETag values match, return a 304 Not Modified status. See the API documentation for ["Conditional Read"](http.html#cread).; (xsd)ifNoneMatch:string>?
< Only perform the operation if the last updated date matches. See the API documentation for ["Conditional Read"](http.html#cread).; (xsd)ifModifiedSince:instant>?
< Only perform the operation if the Etag value matches. For more information, see the API section ["Managing Resource Contention"](http.html#concurrency).; (xsd)ifMatch:string>?
< Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for ["Conditional Create"](http.html#ccreate). This is just the query portion of the URL - what follows the "?" (not including the "?").; (xsd)ifNoneExist:string>?🔗 Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.search-set-bundle.entry.response(xsd)(doc)=
<#base:Bundle.entry.response>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.; (xsd)status:string>
< The location header created by processing this operation, populated if the operation returns a location.; (xsd)location:uri>?
< The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)). Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.; (xsd)etag:string>?
< The date/time that the resource was modified on the server. This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.; (xsd)lastModified:instant>?
< An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction. For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.
This outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.; (xsd)outcome:Resource>?🔗 Information about the search process that lead to the creation of this entry.search-set-bundle.entry.search(xsd)(doc)=
<#base:Bundle.entry.search>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence. Binding: search-entry-mode (required, Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.); (xsd)mode:code>?
< When searching, the server's search ranking score for the entry. Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.
See [Patient Match](patient-operation-match.html) for the EMPI search which relates to this element.; (xsd)score:decimal>?🔗 A series of links that provide context to this bundle. Both Bundle.link and Bundle.entry.link are defined to support providing additional context when Bundles are used (e.g. [HATEOAS](http://en.wikipedia.org/wiki/HATEOAS)).
Bundle.entry.link corresponds to links found in the HTTP header if the resource in the entry was [read](http.html#read) directly.
This specification defines some specific uses of Bundle.link for [searching](search.html#conformance) and [paging](http.html#paging), but no specific uses for Bundle.entry.link, and no defined function in a transaction - the meaning is implementation specific. The behavior of navigation link types (next/prev/first/last) are well defined for searchset and history Bundles but are not currently defined for other types. Implementers who choose to use such link relationships for other bundle types will need to negotiate behavior with their interoperability partners.search-set-bundle.link(xsd)(doc)=
<#base:Bundle.link>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A name which details the functional use for this link - see [http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1](http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1). Binding: iana-link-relations (required, ); (xsd)relation:code>
< The reference details for the link.; (xsd)url:uri>🔗 An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).search-set-bundle.operationOutcome(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< A series of links that provide context to this entry.; (xsd)link:Bundle.link>*
< The Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when:
* invoking a create
* invoking or responding to an operation where the body is not a single identified resource
* invoking or returning the results of a search or history operation. fullUrl might not be [unique in the context of a resource](bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](references.html), the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the [regex](references.html#regex), then the 'id' portion of the fullUrl SHALL end with the Resource.id.
Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).; (xsd)fullUrl:uri>
< The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. This is allowed to be a Parameters resource if and only if it is referenced by something else within the Bundle that provides context/meaning.; (xsd)resource:OperationOutcome>
< Information about the search process that lead to the creation of this entry.; (xsd)search:search-set-bundle.operationOutcome.search>?
< Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.; (xsd)request:search-set-bundle.operationOutcome.request>{0,0}
< Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.; (xsd)response:search-set-bundle.operationOutcome.response>{0,0}🔗 Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.search-set-bundle.operationOutcome.request(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred. Binding: http-verb (required, HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details.); (xsd)method:code>
< The URL for this entry, relative to the root (the address to which the request is posted). E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]".; (xsd)url:uri>
< If the ETag values match, return a 304 Not Modified status. See the API documentation for ["Conditional Read"](http.html#cread).; (xsd)ifNoneMatch:string>?
< Only perform the operation if the last updated date matches. See the API documentation for ["Conditional Read"](http.html#cread).; (xsd)ifModifiedSince:instant>?
< Only perform the operation if the Etag value matches. For more information, see the API section ["Managing Resource Contention"](http.html#concurrency).; (xsd)ifMatch:string>?
< Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for ["Conditional Create"](http.html#ccreate). This is just the query portion of the URL - what follows the "?" (not including the "?").; (xsd)ifNoneExist:string>?🔗 Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.search-set-bundle.operationOutcome.response(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.; (xsd)status:string>
< The location header created by processing this operation, populated if the operation returns a location.; (xsd)location:uri>?
< The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)). Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.; (xsd)etag:string>?
< The date/time that the resource was modified on the server. This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.; (xsd)lastModified:instant>?
< An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction. For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.
This outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.; (xsd)outcome:Resource>?🔗 Information about the search process that lead to the creation of this entry.search-set-bundle.operationOutcome.search(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence. Binding: search-entry-mode (required, Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.); (xsd)mode:code>
< When searching, the server's search ranking score for the entry. Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.
See [Patient Match](patient-operation-match.html) for the EMPI search which relates to this element.; (xsd)score:decimal>?🔗 An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).search-set-bundle.other(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< A series of links that provide context to this entry.; (xsd)link:Bundle.link>*
< The Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when:
* invoking a create
* invoking or responding to an operation where the body is not a single identified resource
* invoking or returning the results of a search or history operation. fullUrl might not be [unique in the context of a resource](bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](references.html), the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the [regex](references.html#regex), then the 'id' portion of the fullUrl SHALL end with the Resource.id.
Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).; (xsd)fullUrl:uri>
< The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. This is allowed to be a Parameters resource if and only if it is referenced by something else within the Bundle that provides context/meaning.; (xsd)resource:Resource>
< Information about the search process that lead to the creation of this entry.; (xsd)search:search-set-bundle.other.search>?
< Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.; (xsd)request:search-set-bundle.other.request>{0,0}
< Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.; (xsd)response:search-set-bundle.other.response>{0,0}🔗 Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.search-set-bundle.other.request(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred. Binding: http-verb (required, HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details.); (xsd)method:code>
< The URL for this entry, relative to the root (the address to which the request is posted). E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]".; (xsd)url:uri>
< If the ETag values match, return a 304 Not Modified status. See the API documentation for ["Conditional Read"](http.html#cread).; (xsd)ifNoneMatch:string>?
< Only perform the operation if the last updated date matches. See the API documentation for ["Conditional Read"](http.html#cread).; (xsd)ifModifiedSince:instant>?
< Only perform the operation if the Etag value matches. For more information, see the API section ["Managing Resource Contention"](http.html#concurrency).; (xsd)ifMatch:string>?
< Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for ["Conditional Create"](http.html#ccreate). This is just the query portion of the URL - what follows the "?" (not including the "?").; (xsd)ifNoneExist:string>?🔗 Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.search-set-bundle.other.response(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.; (xsd)status:string>
< The location header created by processing this operation, populated if the operation returns a location.; (xsd)location:uri>?
< The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)). Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.; (xsd)etag:string>?
< The date/time that the resource was modified on the server. This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.; (xsd)lastModified:instant>?
< An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction. For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.
This outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.; (xsd)outcome:Resource>?🔗 Information about the search process that lead to the creation of this entry.search-set-bundle.other.search(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence. Binding: search-entry-mode (required, Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.); (xsd)mode:code>?
< When searching, the server's search ranking score for the entry. Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.
See [Patient Match](patient-operation-match.html) for the EMPI search which relates to this element.; (xsd)score:decimal>?🔗 Optional Extension Element - found in all resources.ServiceBillingCode(xsd)(doc)=
<#base:Extension>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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. http://hl7.org/fhir/uv/order-catalog/StructureDefinition/ServiceBillingCode; (xsd)url:string>
(<valueCodeableConcept:CodeableConcept>
|<valueResource:Resource>)?
< Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R5/extensibility.html) for a list).; (xsd)valueCodeableConcept:CodeableConcept>?
< Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R5/extensibility.html) for a list).; (xsd)valueReference:LabChargeItemDefinition*>?🔗 A record of a request for service such as diagnostic investigations, treatments, or operations to be performed.ServiceRequest(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< Identifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller. The identifier.type element is used to distinguish between the identifiers assigned by the orderer (known as the 'Placer' in HL7 V2) and the producer of the observations in response to the order (known as the 'Filler' in HL7 V2). For further discussion and examples see the resource notes section below.; (xsd)identifier:Identifier>*
[]< The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this ServiceRequest. The PlanDefinition resource is used to describe series, sequences, or groups of actions to be taken, while the ActivityDefinition resource is used to define each specific step or activity to be performed. More information can be found in the [Boundaries and Relationships](plandefinition.html#12.23.2) section for PlanDefinition.; (xsd)instantiatesCanonical:(<ActivityDefinition>
|<PlanDefinition>)>*
[]< The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this ServiceRequest. This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.; (xsd)instantiatesUri:uri>*
[]< Plan/proposal/order fulfilled by this request.; (xsd)basedOn:(<CarePlan>
|<MedicationRequest>
|<ServiceRequest>)>*
[]< The request takes the place of the referenced completed or terminated request(s).; (xsd)replaces:ServiceRequest*>*
< A shared identifier common to all service requests that were authorized more or less simultaneously by a single author, representing the composite or group identifier. Requests are linked either by a "basedOn" relationship (i.e. one request is fulfilling another) or by having a common requisition. Requests that are part of the same requisition are generally treated independently from the perspective of changing their state or maintaining them after initial creation.; (xsd)requisition:Identifier>?
< The status of the order. The status is generally fully in the control of the requester - they determine whether the order is draft or active and, after it has been activated, competed, revoked or placed on-hold. States relating to the activities of the performer are reflected on either the corresponding event (see [Event Pattern](event.html) for general discussion) or using the [Task](task.html) resource. Binding: request-status (required, The status of a service order.); (xsd)status:code>
< Whether the request is a proposal, plan, an original order or a reflex order. This element is labeled as a modifier because the intent alters when and how the resource is actually applicable. Binding: request-intent (required, The kind of service request.); (xsd)intent:code>
[]< A code that classifies the service for searching, sorting and display purposes (e.g. "Surgical Procedure"). There may be multiple axis of categorization depending on the context or use case for retrieving or displaying the resource. The level of granularity is defined by the category concepts in the value set. Binding: servicerequest-category (example, Classification of the requested service.); (xsd)category:CodeableConcept>*
< Indicates how quickly the ServiceRequest should be addressed with respect to other requests. Binding: request-priority (required, Identifies the level of importance to be assigned to actioning the request.); (xsd)priority:code>?
< Set this to true if the record is saying that the service/procedure should NOT be performed. In general, only the code and timeframe will be present, though occasional additional qualifiers such as body site or even performer could be included to narrow the scope of the prohibition. If the ServiceRequest.code and ServiceRequest.doNotPerform both contain negation, that will reinforce prohibition and should not have a double negative interpretation.; (xsd)doNotPerform:boolean>?
< A code or reference that identifies a particular service (i.e., procedure, diagnostic investigation, or panel of investigations) that have been requested. Many laboratory and radiology procedure codes embed the specimen/organ system in the test order name, for example, serum or serum/plasma glucose, or a chest x-ray. The specimen might not be recorded separately from the test code. Binding: procedure-code (example, Codes for tests or services that can be carried out by a designated individual, organization or healthcare service. For laboratory, LOINC is [preferred](terminologies.html#preferred) and a valueset using LOINC Order codes is available [here](valueset-diagnostic-requests.html).); (xsd)code:(<ActivityDefinition>
|<PlanDefinition>)>?
[]< Additional details and instructions about the how the services are to be delivered. For example, and order for a urinary catheter may have an order detail for an external or indwelling catheter, or an order for a bandage may require additional instructions specifying how the bandage should be applied. For information from the medical record intended to support the delivery of the requested services, use the `supportingInformation` element.; (xsd)orderDetail:ServiceRequest.orderDetail>*
< An amount of service being requested which can be a quantity ( for example $1,500 home modification), a ratio ( for example, 20 half day visits per month), or a range (2.0 to 1.8 Gy per fraction).; (xsd)quantity:(<Quantity>
|<Range>
|<Ratio>)>?
< On whom or what the service is to be performed. This is usually a human patient, but can also be requested on animals, groups of humans or animals, devices such as dialysis machines, or even locations (typically for environmental scans).; (xsd)subject:(<Device>
|<Group>
|<Location>
|<Patient>)>
[]< The actual focus of a service request when it is not the subject of record representing something or someone associated with the subject such as a spouse, parent, fetus, or donor. The focus of a service request could also be an existing condition, an intervention, the subject's diet, another service request on the subject, or a body structure such as tumor or implanted device.; (xsd)focus:Resource*>*
< An encounter that provides additional information about the healthcare context in which this request is made.; (xsd)encounter:Encounter*>?
< The date/time at which the requested service should occur.; (xsd)occurrence:(<dateTime>
|<Period>
|<Timing>)>?
< If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example "pain", "on flare-up", etc. Binding: medication-as-needed-reason (example, A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc.); (xsd)asNeeded:(<boolean>
|<CodeableConcept>)>?
< When the request transitioned to being actionable.; (xsd)authoredOn:dateTime>?
< The individual who initiated the request and has responsibility for its activation. This not the dispatcher, but rather who is the authorizer. This element is not intended to handle delegation which would generally be managed through the Provenance resource.; (xsd)requester:(<Device>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>?
< Desired type of performer for doing the requested service. This is a role, not a participation type. In other words, does not describe the task but describes the capacity. For example, “compounding pharmacy”, “psychiatrist” or “internal referral”. Binding: participant-role (example, Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc.); (xsd)performerType:CodeableConcept>?
[]< The desired performer for doing the requested service. For example, the surgeon, dermatopathologist, endoscopist, etc. If multiple performers are present, it is interpreted as a list of *alternative* performers without any preference regardless of order. If order of preference is needed use the [http://hl7.org/fhir/StructureDefinition/request-performerOrder](http://hl7.org/fhir/extensions/StructureDefinition-request-performerOrder.html). Use CareTeam to represent a group of performers (for example, Practitioner A *and* Practitioner B).; (xsd)performer:(<CareTeam>
|<Device>
|<HealthcareService>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>*
[]< The preferred location(s) where the procedure should actually happen in coded or free text form. E.g. at home or nursing day care center. Binding: http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType (example, A location type where services are delivered.); (xsd)location:Location*>*
[]< An explanation or justification for why this service is being requested in coded or textual form. This is often for billing purposes. May relate to the resources referred to in `supportingInfo`. This element represents why the referral is being made and may be used to decide how the service will be performed, or even if it will be performed at all. To be as specific as possible, a reference to *Observation* or *Condition* should be used if available. Otherwise, use `concept.text` element if the data is free (uncoded) text as shown in the [CT Scan example](servicerequest-example-di.html). Binding: procedure-reason (example, SNOMED CT Condition/Problem/Diagnosis Codes); (xsd)reason:(<Condition>
|<DetectedIssue>
|<DiagnosticReport>
|<DocumentReference>
|<Observation>)>*
[]< Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be needed for delivering the requested service.; (xsd)insurance:(<ClaimResponse>
|<Coverage>)>*
[]< Additional clinical information about the patient or specimen that may influence the services or their interpretations. This information includes diagnosis, clinical findings and other observations. In laboratory ordering these are typically referred to as "ask at order entry questions (AOEs)". This includes observations explicitly requested by the producer (filler) to provide context or supporting information needed to complete the order. For example, reporting the amount of inspired oxygen for blood gas measurements. To represent information about how the services are to be delivered use the `instructions` element.; (xsd)supportingInfo:Resource*>*
[]< One or more specimens that the laboratory procedure will use. The purpose of the ServiceRequest.specimen is to reflect the actual specimen that the requested test/procedure is asked to be performed on, whether the lab already has it or not. References to specimens for purposes other than to perform a test/procedure on should be made using the ServiceRequest.supportingInfo or the Specimen.parent where the Specimen.parent would enable descendency and ServiceRequest.supportingInfo a general reference for context.; (xsd)specimen:Specimen*>*
[]< Anatomic location where the procedure should be performed. This is the target site. Only used if not implicit in the code found in ServiceRequest.code. If the use case requires BodySite to be handled as a separate resource instead of an inline coded element (e.g. to identify and track separately) then use the standard extension [http://hl7.org/fhir/StructureDefinition/procedure-targetBodyStructure](http://hl7.org/fhir/extensions/StructureDefinition-procedure-targetBodyStructure.html). Binding: body-site (example, SNOMED CT Body site concepts); (xsd)bodySite:CodeableConcept>*
< Anatomic location where the procedure should be performed. This is the target site.; (xsd)bodyStructure:BodyStructure*>?
[]< Any other notes and comments made about the service request. For example, internal billing notes.; (xsd)note:Annotation>*
[]< Instructions in terms that are understood by the patient or consumer.; (xsd)patientInstruction:ServiceRequest.patientInstruction>*
[]< Key events in the history of the request. This might not include provenances for all versions of the request – only those deemed “relevant” or important.
This SHALL NOT include the Provenance associated with this current version of the resource. (If that provenance is deemed to be a “relevant” change, it will need to be added as part of a later update. Until then, it can be queried directly as the Provenance that points to this version using _revinclude
All Provenances should have some historical version of this Request as their subject.; (xsd)relevantHistory:Provenance*>*🔗 Additional details and instructions about the how the services are to be delivered. For example, and order for a urinary catheter may have an order detail for an external or indwelling catheter, or an order for a bandage may require additional instructions specifying how the bandage should be applied. For information from the medical record intended to support the delivery of the requested services, use the `supportingInformation` element.ServiceRequest.orderDetail(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Indicates the context of the order details by reference.; (xsd)parameterFocus:(<BiologicallyDerivedProduct>
|<Device>
|<DeviceDefinition>
|<DeviceRequest>
|<Medication>
|<MedicationRequest>
|<Substance>
|<SupplyRequest>)>?
[]< The parameter details for the service being requested.; (xsd)parameter:ServiceRequest.orderDetail.parameter>+🔗 The parameter details for the service being requested.ServiceRequest.orderDetail.parameter(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A value representing the additional detail or instructions for the order (e.g., catheter insertion, body elevation, descriptive device configuration and/or setting instructions). Binding: servicerequest-orderdetail-parameter-code (example, Codes for order detail parameters.); (xsd)code:CodeableConcept>
(<valueBoolean:boolean>
|<valueCodeableConcept:CodeableConcept>
|<valuePeriod:Period>
|<valueQuantity:Quantity>
|<valueRange:Range>
|<valueRatio:Ratio>
|<valueString:string>)🔗 Instructions in terms that are understood by the patient or consumer.ServiceRequest.patientInstruction(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Instructions in terms that are understood by the patient or consumer.; (xsd)instruction:(<DocumentReference>
|<markdown>)>?🔗 This resource allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context.shareableactivitydefinition(xsd)(doc)=
<#base:ActivityDefinition>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< An Extension; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< An absolute URI that is used to identify this activity definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this activity definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the activity definition is stored on different servers. Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.
The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions).
In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.; (xsd)url:uri>
[]< A formal identifier that is used to identify this activity definition when it is represented in other formats, or referenced in a specification, model, design or an instance. Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this activity definition outside of FHIR, where it is not possible to use the logical URI.; (xsd)identifier:Identifier>*
< The identifier that is used to identify this version of the activity definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the activity definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active assets. There may be different activity definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the activity definition with the format [url]|[version]. The version SHOULD NOT contain a '#' - see [Business Version](resource.html#bv-format).; (xsd)version:string>
< Indicates the mechanism used to compare versions to determine which is more current. If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined. Binding: version-algorithm (extensible, ); (xsd)versionAlgorithm:(<Coding>
|<string>)>?
< A natural language name identifying the activity definition. This name should be usable as an identifier for the module by machine processing applications such as code generation. The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.; (xsd)name:string>?
< A short, descriptive, user-friendly title for the activity definition. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.; (xsd)title:string>
< An explanatory or alternate title for the activity definition giving additional information about its content.; (xsd)subtitle:string>?
< The status of this activity definition. Enables tracking the life-cycle of the content. Allows filtering of activity definitions that are appropriate for use versus not.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization). Binding: publication-status (required, The lifecycle status of an artifact.); (xsd)status:code>
< A Boolean value to indicate that this activity definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. Allows filtering of activity definitions that are appropriate for use versus not.; (xsd)experimental:boolean>
< A code, group definition, or canonical reference that describes or identifies the intended subject of the activity being defined. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource. Note that the choice of canonical for the subject element was introduced in R4B to support pharmaceutical quality use cases. To ensure as much backwards-compatibility as possible, it is recommended to only use the new canonical type with these use cases. Binding: participant-resource-types (extensible, The possible types of subjects for an activity (E.g. Patient, Practitioner, Organization, Location, etc.).); (xsd)subject:(<AdministrableProductDefinition>
|<CodeableConcept>
|<EvidenceVariable>
|<Group>
|<ManufacturedItemDefinition>
|<MedicinalProductDefinition>
|<PackagedProductDefinition>
|<SubstanceDefinition>)>?
< The date (and optionally time) when the activity definition was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the activity definition changes. The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the activity definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)date:dateTime>?
< The name of the organization or individual responsible for the release and ongoing maintenance of the activity definition. Usually an organization but may be an individual. The publisher (or steward) of the activity definition is the organization or individual primarily responsible for the maintenance and upkeep of the activity definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the activity definition. This item SHOULD be populated unless the information is available from context.; (xsd)publisher:string>?
[]< Contact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)contact:ContactDetail>*
< A free text natural language description of the activity definition from a consumer's perspective. This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the activity definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the activity definition is presumed to be the predominant language in the place the activity definition was created).; (xsd)description:markdown>
[]< The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate activity definition instances. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.; (xsd)useContext:UsageContext>*
[]< A legal or geographic region in which the activity definition is intended to be used. It may be possible for the activity definition to be used in jurisdictions other than those for which it was originally designed or intended.
DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.) Binding: jurisdiction (extensible, Countries and regions within which this artifact is targeted for use.); (xsd)jurisdiction:CodeableConcept>*
< Explanation of why this activity definition is needed and why it has been designed as it has. This element does not describe the usage of the activity definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this activity definition.; (xsd)purpose:markdown>?
< A detailed description of how the activity definition is used from a clinical perspective.; (xsd)usage:markdown>?
< A copyright statement relating to the activity definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the activity definition. The short copyright declaration (e.g. (c) '2015+ xyz organization' should be sent in the copyrightLabel element.; (xsd)copyright:markdown>?
< A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved'). The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.; (xsd)copyrightLabel:string>?
< The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)approvalDate:date>?
< The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. If specified, this date follows the original approval date.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)lastReviewDate:date>?
< The period during which the activity definition content was or is planned to be in active use. The effective period for an activity definition determines when the content is applicable for usage and is independent of publication and review dates. For example, a activity intended to be used for the year 2016 might be published in 2015.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)effectivePeriod:Period>?
[]< Descriptive topics related to the content of the activity. Topics provide a high-level categorization of the activity that can be useful for filtering and searching. DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'topic' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#topic and useContext.valueCodeableConcept indicating the topic) Binding: definition-topic (example, High-level categorization of the definition, used for searching, sorting, and filtering.); (xsd)topic:CodeableConcept>*
[]< An individiual or organization primarily involved in the creation and maintenance of the content.; (xsd)author:ContactDetail>*
[]< An individual or organization primarily responsible for internal coherence of the content.; (xsd)editor:ContactDetail>*
[]< An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the content. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)reviewer:ContactDetail>*
[]< An individual or organization asserted by the publisher to be responsible for officially endorsing the content for use in some setting. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)endorser:ContactDetail>*
[]< Related artifacts such as additional documentation, justification, or bibliographic references. Each related artifact is either an attachment, or a reference to another resource, but not both.; (xsd)relatedArtifact:RelatedArtifact>*
[]< A reference to a Library resource containing any formal logic used by the activity definition.; (xsd)library:Library*>*
< A description of the kind of resource the activity definition is representing. For example, a MedicationRequest, a ServiceRequest, or a CommunicationRequest. The kind element may only specify Request resource types to facilitate considering user input as part of processing the result of any automated clinical reasoning processes. To support creation of event resources, such as Observations, RiskAssessments, and DetectedIssues, use a Task resource with the focus of the task set to the event resource to be created. Note that the kind of resource to be created may determine what types of extensions are permitted. Binding: request-resource-types (required, The kind of activity the definition is describing.); (xsd)kind:code>?
< A profile to which the target of the activity definition is expected to conform.; (xsd)profile:StructureDefinition*>?
< Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter. Tends to be less relevant for activities involving particular products. Binding: procedure-code (example, Detailed type of the activity; e.g. CBC.); (xsd)code:CodeableConcept>?
< Indicates the level of authority/intentionality associated with the activity and where the request should fit into the workflow chain. Binding: request-intent (required, Codes indicating the degree of authority/intentionality associated with a request.); (xsd)intent:code>?
< Indicates how quickly the activity should be addressed with respect to other requests. Binding: request-priority (required, Identifies the level of importance to be assigned to actioning the request.); (xsd)priority:code>?
< Set this to true if the definition is to indicate that a particular activity should NOT be performed. If true, this element should be interpreted to reinforce a negative coding. For example NPO as a code with a doNotPerform of true would still indicate to NOT perform the action. This element is not intended to be used to communicate a decision support response to cancel an order in progress. That should be done with the "remove" type of a PlanDefinition or RequestOrchestration.; (xsd)doNotPerform:boolean>?
< The timing or frequency upon which the described activity is to occur. The intent of the timing element is to provide timing when the action should be performed. As a definitional resource, this timing is interpreted as part of an apply operation so that the timing of the result actions in a CarePlan or RequestOrchestration, for example, would be specified by evaluating the timing definition in the context of the apply and setting the resulting timing on the appropriate elements of the target resource. If the timing is an Age, the activity is expected to be performed when the subject is the given Age. When the timing is a Duration, the activity is expected to be performed within the specified duration from the apply. When the timing is a Range, it may be a range of Ages or Durations, providing a range for the expected timing of the resulting activity. When the timing is a Timing, it is establishing a schedule for the timing of the resulting activity.; (xsd)timing:(<Age>
|<Duration>
|<Range>
|<Timing>)>?
< If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example "pain", "on flare-up", etc. Binding: medication-as-needed-reason (example, A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc.); (xsd)asNeeded:(<boolean>
|<CodeableConcept>)>?
< Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc. May reference a specific clinical location or may just identify a type of location.; (xsd)location:Location*>?
[]< Indicates who should participate in performing the action described.; (xsd)participant:shareableactivitydefinition.participant>*
< Identifies the food, drug or other product being consumed or supplied in the activity. Binding: medication-codes (example, Code describing the type of substance or medication.); (xsd)product:(<CodeableConcept>
|<Ingredient>
|<Medication>
|<Substance>
|<SubstanceDefinition>)>?
< Identifies the quantity expected to be consumed at once (per dose, per meal, etc.).; (xsd)quantity:SimpleQuantity>?
[]< Provides detailed dosage instructions in the same way that they are described for MedicationRequest resources. If a dosage instruction is used, the definition should not specify timing or quantity.; (xsd)dosage:Dosage>*
[]< Indicates the sites on the subject's body where the procedure should be performed (I.e. the target sites). Only used if not implicit in the code found in ServiceRequest.type. Binding: body-site (example, A code that identifies the anatomical location.); (xsd)bodySite:CodeableConcept>*
[]< Defines specimen requirements for the action to be performed, such as required specimens for a lab test.; (xsd)specimenRequirement:SpecimenDefinition*>*
[]< Defines observation requirements for the action to be performed, such as body weight or surface area.; (xsd)observationRequirement:ObservationDefinition*>*
[]< Defines the observations that are expected to be produced by the action.; (xsd)observationResultRequirement:ObservationDefinition*>*
< A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input. Note that if both a transform and dynamic values are specified, the dynamic values will be applied to the result of the transform.; (xsd)transform:StructureMap*>?
[]< Dynamic values that will be evaluated to produce values for elements of the resulting resource. For example, if the dosage of a medication must be computed based on the patient's weight, a dynamic value would be used to specify an expression that calculated the weight, and the path on the request resource that would contain the result. Dynamic values are applied in the order in which they are defined in the ActivityDefinition. Note that if both a transform and dynamic values are specified, the dynamic values will be applied to the result of the transform.; (xsd)dynamicValue:shareableactivitydefinition.dynamicValue>*
[]< Defines a knowledge capability afforded by this knowledge artifact.; (xsd)knowledgeCapability:Extension>*
[]< Defines a knowledge representation level provided by this knowledge artifact.; (xsd)knowledgeRepresentationLevel:Extension>*
[]< A comment containing additional documentation, a review comment, usage guidance, or other relevant information from a particular user.; (xsd)artifactComment:Extension>*🔗 Dynamic values that will be evaluated to produce values for elements of the resulting resource. For example, if the dosage of a medication must be computed based on the patient's weight, a dynamic value would be used to specify an expression that calculated the weight, and the path on the request resource that would contain the result. Dynamic values are applied in the order in which they are defined in the ActivityDefinition. Note that if both a transform and dynamic values are specified, the dynamic values will be applied to the result of the transform.shareableactivitydefinition.dynamicValue(xsd)(doc)=
<#base:ActivityDefinition.dynamicValue>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The path to the element to be customized. This is the path on the resource that will hold the result of the calculation defined by the expression. The specified path SHALL be a FHIRPath resolvable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. 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). The path attribute contains a [Simple FHIRPath Subset](fhirpath.html#simple) that allows path traversal, but not calculation.; (xsd)path:string>
< An expression specifying the value of the customized element. The expression may be inlined, or may be a reference to a named expression within a logic library referenced by the library element.; (xsd)expression:Expression>🔗 Indicates who should participate in performing the action described.shareableactivitydefinition.participant(xsd)(doc)=
<#base:ActivityDefinition.participant>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The type of participant in the action. Binding: action-participant-type (required, The type of participant in the activity.); (xsd)type:code>?
< The type of participant in the action.; (xsd)typeCanonical:CapabilityStatement*>?
< The type of participant in the action. When this element is a reference, it SHOULD be a reference to a definitional resource (for example, a location type, rather than a specific location).; (xsd)typeReference:(<CareTeam>
|<Device>
|<DeviceDefinition>
|<Endpoint>
|<Group>
|<HealthcareService>
|<Location>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>?
< The role the participant should play in performing the described action. Binding: http://terminology.hl7.org/ValueSet/action-participant-role (example, Defines roles played by participants for the action.); (xsd)role:CodeableConcept>?
< Indicates how the actor will be involved in the action - author, reviewer, witness, etc. Binding: action-participant-function (example, ); (xsd)function:CodeableConcept>?🔗 The CodeSystem resource is used to declare the existence of and describe a code system or code system supplement and its key properties, and optionally define a part or all of its content.shareablecodesystem(xsd)(doc)=
<#base:CodeSystem>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< An Extension; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< An absolute URI that is used to identify this code system when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this code system is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the code system is stored on different servers. This is used in [Coding](datatypes.html#Coding).system. Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.
The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions).
In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.; (xsd)url:uri>
[]< A formal identifier that is used to identify this code system when it is represented in other formats, or referenced in a specification, model, design or an instance. Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this code system outside of FHIR, where it is not possible to use the logical URI. Note that HL7 defines at least three identifiers for many of its code systems - the FHIR canonical URL, the OID and the V2 Table 0396 mnemonic code.; (xsd)identifier:Identifier>*
< The identifier that is used to identify this version of the code system when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the code system author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. This is used in [Coding](datatypes.html#Coding).version. There may be different code system instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the code system with the format [url]|[version]. The version SHOULD NOT contain a '#' - see [Business Version](resource.html#bv-format).; (xsd)version:string>
< Indicates the mechanism used to compare versions to determine which CodeSystem is more current. If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined. Binding: version-algorithm (extensible, ); (xsd)versionAlgorithm:(<Coding>
|<string>)>?
< A natural language name identifying the code system. This name should be usable as an identifier for the module by machine processing applications such as code generation. The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.; (xsd)name:string>?
< A short, descriptive, user-friendly title for the code system. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.; (xsd)title:string>
< The status of this code system. Enables tracking the life-cycle of the content. Allows filtering of code systems that are appropriate for use versus not.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization). Binding: publication-status (required, The lifecycle status of an artifact.); (xsd)status:code>
< A Boolean value to indicate that this code system is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. Allows filtering of code systems that are appropriate for use versus not.; (xsd)experimental:boolean>
< The date (and optionally time) when the code system was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the code system changes. The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the code system. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)date:dateTime>?
< The name of the organization or individual responsible for the release and ongoing maintenance of the code system. Usually an organization but may be an individual. The publisher (or steward) of the code system is the organization or individual primarily responsible for the maintenance and upkeep of the code system. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the code system. This item SHOULD be populated unless the information is available from context.; (xsd)publisher:string>?
[]< Contact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)contact:ContactDetail>*
< A free text natural language description of the code system from a consumer's perspective. This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the code system as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the code system is presumed to be the predominant language in the place the code system was created).; (xsd)description:markdown>
[]< The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate code system instances. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.; (xsd)useContext:UsageContext>*
[]< A legal or geographic region in which the code system is intended to be used. It may be possible for the code system to be used in jurisdictions other than those for which it was originally designed or intended.
DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.) Binding: jurisdiction (extensible, Countries and regions within which this artifact is targeted for use.); (xsd)jurisdiction:CodeableConcept>*
< Explanation of why this code system is needed and why it has been designed as it has. This element does not describe the usage of the code system. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this code system.; (xsd)purpose:markdown>?
< A copyright statement relating to the code system and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the code system. ... Sometimes, the copyright differs between the code system and the codes that are included. The copyright statement should clearly differentiate between these when required.; (xsd)copyright:markdown>?
< A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved'). The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.; (xsd)copyrightLabel:string>?
< The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)approvalDate:date>?
< The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. If specified, this date follows the original approval date.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)lastReviewDate:date>?
< The period during which the CodeSystem content was or is planned to be in active use. The effective period for a CodeSystem determines when the content is applicable for usage and is independent of publication and review dates. For example, a system intended to be used for the year 2016 might be published in 2015.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)effectivePeriod:Period>?
[]< Descriptions related to the content of the CodeSystem. Topics provide a high-level categorization as well as keywords for the CodeSystem that can be useful for filtering and searching. DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'topic' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#topic and useContext.valueCodeableConcept indicating the topic) Binding: definition-topic (example, ); (xsd)topic:CodeableConcept>*
[]< An individiual or organization primarily involved in the creation and maintenance of the CodeSystem.; (xsd)author:ContactDetail>*
[]< An individual or organization primarily responsible for internal coherence of the CodeSystem.; (xsd)editor:ContactDetail>*
[]< An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the CodeSystem. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)reviewer:ContactDetail>*
[]< An individual or organization asserted by the publisher to be responsible for officially endorsing the CodeSystem for use in some setting. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)endorser:ContactDetail>*
[]< Related artifacts such as additional documentation, justification, dependencies, bibliographic references, and predecessor and successor artifacts. Each related artifact is either an attachment, or a reference to another resource, but not both.; (xsd)relatedArtifact:RelatedArtifact>*
< If code comparison is case sensitive when codes within this system are compared to each other. If this value is missing, then it is not specified whether a code system is case sensitive or not. When the rule is not known, Postel's law should be followed: produce codes with the correct case, and accept codes in any case. This element is primarily provided to support validation software.; (xsd)caseSensitive:boolean>
< Canonical reference to the value set that contains all codes in the code system independent of code status. The definition of the value set SHALL include all codes from this code system, independent of concept status, and only codes from this code system. It SHALL be immutable, and operations SHOULD support validation of any allowed code compositions.; (xsd)valueSet:ValueSet*>?
< The meaning of the hierarchy of concepts as represented in this resource. Note that other representations might have a different hierarchy or none at all, and represent the information using properties. Binding: codesystem-hierarchy-meaning (required, The meaning of the hierarchy of concepts in a code system.); (xsd)hierarchyMeaning:code>?
< The code system defines a compositional (post-coordination) grammar. Note that the code system resource does not define what the compositional grammar is, only whether or not there is one.; (xsd)compositional:boolean>?
< This flag is used to signify that the code system does not commit to concept permanence across versions. If true, a version must be specified when referencing this code system. Best practice is that code systems do not redefine concepts, or that if concepts are redefined, a new code system definition is created. But this is not always possible, so some code systems may be defined as 'versionNeeded'.
Most code systems occasionally refine the displays defined for concepts between versions. Contexts in which the concept display values are validated may require that the version be specified for some code systems irrespective of the value of this property.; (xsd)versionNeeded:boolean>?
< The extent of the content of the code system (the concepts and codes it defines) are represented in this resource instance. Binding: codesystem-content-mode (required, The extent of the content of the code system (the concepts and codes it defines) are represented in a code system resource.); (xsd)content:code>
< The canonical URL of the code system that this code system supplement is adding designations and properties to. The most common use of a code system supplement is to add additional language support.; (xsd)supplements:CodeSystem*>?
< The total number of concepts defined by the code system. Where the code system has a compositional grammar, the basis of this count is defined by the system steward. The count of concepts defined in this resource cannot be more than this value but may be less for several reasons - see the content element.; (xsd)count:unsignedInt>?
[]< A filter that can be used in a value set compose statement when selecting concepts using a filter. Note that filters defined in code systems usually require custom code on the part of any terminology engine that will make them available for use in value set filters. For this reason, they are generally only seen in high value published terminologies.; (xsd)filter:shareablecodesystem.filter>*
[]< A property defines an additional slot through which additional information can be provided about a concept. Multiple occurrences of CodeSystem.concept.property may occur for a CodeSystem.property where CodeSystem.concept.property.code is the same and CodeSystem.concept.property.value differs. For example: multiple designations for a single concept.; (xsd)property:shareablecodesystem.property>*
[]< Concepts that are in the code system. The concept definitions are inherently hierarchical, but the definitions must be consulted to determine what the meanings of the hierarchical relationships are. If this is empty, it means that the code system resource does not represent the content of the code system.; (xsd)concept:shareablecodesystem.concept>*
[]< Defines a knowledge representation level provided by this knowledge artifact.; (xsd)knowledgeRepresentationLevel:Extension>*🔗 Concepts that are in the code system. The concept definitions are inherently hierarchical, but the definitions must be consulted to determine what the meanings of the hierarchical relationships are. If this is empty, it means that the code system resource does not represent the content of the code system.shareablecodesystem.concept(xsd)(doc)=
<#base:CodeSystem.concept>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A code - a text symbol - that uniquely identifies the concept within the code system.; (xsd)code>
< A human readable string that is the recommended default way to present this concept to a user.; (xsd)display:string>?
< The formal definition of the concept. The code system resource does not make formal definitions required, because of the prevalence of legacy systems. However, they are highly recommended, as without them there is no formal meaning associated with the concept.; (xsd)definition:string>?
[]< Additional representations for the concept - other languages, aliases, specialized purposes, used for particular purposes, etc. Concepts have both a ```display``` and an array of ```designation```. The display is equivalent to a special designation with an implied ```designation.use``` of "primary code" and a language equal to the [Resource Language](resource.html#language).; (xsd)designation:shareablecodesystem.concept.designation>*
[]< A property value for this concept.; (xsd)property:shareablecodesystem.concept.property>*
[]< Defines children of a concept to produce a hierarchy of concepts. The nature of the relationships is variable (is-a/contains/categorizes) - see hierarchyMeaning.; (xsd)concept:CodeSystem.concept>*🔗 Additional representations for the concept - other languages, aliases, specialized purposes, used for particular purposes, etc. Concepts have both a ```display``` and an array of ```designation```. The display is equivalent to a special designation with an implied ```designation.use``` of "primary code" and a language equal to the [Resource Language](resource.html#language).shareablecodesystem.concept.designation(xsd)(doc)=
<#base:CodeSystem.concept.designation>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The language this designation is defined for. In the absence of a language, the resource language applies. Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< A code that details how this designation would be used. If no use is provided, the designation can be assumed to be suitable for general display to a human user. Binding: designation-use (extensible, Details of how a designation would be used.); (xsd)use:Coding>?
[]< Additional codes that detail how this designation would be used, if there is more than one use. This was added rather than increasing the cardinality of .use to 0..* in order to maintain backward compatibility. Binding: designation-use (extensible, Details of how a designation would be used.); (xsd)additionalUse:Coding>*
< The text value for this designation.; (xsd)value:string>🔗 A property value for this concept.shareablecodesystem.concept.property(xsd)(doc)=
<#base:CodeSystem.concept.property>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A code that is a reference to CodeSystem.property.code.; (xsd)code>
(<valueBoolean:boolean>
|<valueCode:code>
|<valueCoding:Coding>
|<valueDateTime:dateTime>
|<valueDecimal:decimal>
|<valueInteger:integer>
|<valueString:string>)🔗 A filter that can be used in a value set compose statement when selecting concepts using a filter. Note that filters defined in code systems usually require custom code on the part of any terminology engine that will make them available for use in value set filters. For this reason, they are generally only seen in high value published terminologies.shareablecodesystem.filter(xsd)(doc)=
<#base:CodeSystem.filter>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The code that identifies this filter when it is used as a filter in [ValueSet](valueset.html#).compose.include.filter.; (xsd)code>
< A description of how or why the filter is used.; (xsd)description:string>?
[]< A list of operators that can be used with the filter. Binding: filter-operator (required, The kind of operation to perform as a part of a property based filter.); (xsd)operator:code>+
< A description of what the value for the filter should be.; (xsd)value:string>🔗 A property defines an additional slot through which additional information can be provided about a concept. Multiple occurrences of CodeSystem.concept.property may occur for a CodeSystem.property where CodeSystem.concept.property.code is the same and CodeSystem.concept.property.value differs. For example: multiple designations for a single concept.shareablecodesystem.property(xsd)(doc)=
<#base:CodeSystem.property>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A code that is used to identify the property. The code is used internally (in CodeSystem.concept.property.code) and also externally, such as in property filters.; (xsd)code>
< Reference to the formal meaning of the property. One possible source of meaning is the [Concept Properties](codesystem-concept-properties.html) code system.; (xsd)uri>?
< A description of the property- why it is defined, and how its value might be used.; (xsd)description:string>?
< The type of the property value. Properties of type "code" contain a code defined by the code system (e.g. a reference to another defined concept). Binding: concept-property-type (required, The type of a property value.); (xsd)type:code>🔗 A statement of relationships from one set of concepts to one or more other concepts - either concepts in code systems, or data element/data element concepts, or classes in class models.shareableconceptmap(xsd)(doc)=
<#base:ConceptMap>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< An Extension; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< An absolute URI that is used to identify this concept map when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this concept map is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the concept map is stored on different servers. Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.
The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions).
In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.; (xsd)url:uri>
[]< A formal identifier that is used to identify this concept map when it is represented in other formats, or referenced in a specification, model, design or an instance. Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this concept map outside of FHIR, where it is not possible to use the logical URI.; (xsd)identifier:Identifier>*
< The identifier that is used to identify this version of the concept map when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the concept map author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. There may be different concept map instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the concept map with the format [url]|[version]. The version SHOULD NOT contain a '#' - see [Business Version](resource.html#bv-format).; (xsd)version:string>
< Indicates the mechanism used to compare versions to determine which ConceptMap is more current. If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined. Binding: version-algorithm (extensible, ); (xsd)versionAlgorithm:(<Coding>
|<string>)>?
< A natural language name identifying the concept map. This name should be usable as an identifier for the module by machine processing applications such as code generation. The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.; (xsd)name:string>?
< A short, descriptive, user-friendly title for the concept map. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.; (xsd)title:string>
< The status of this concept map. Enables tracking the life-cycle of the content. Allows filtering of concept maps that are appropriate for use versus not.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization). Binding: publication-status (required, The lifecycle status of an artifact.); (xsd)status:code>
< A Boolean value to indicate that this concept map is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. Allows filtering of concept maps that are appropriate for use versus not.; (xsd)experimental:boolean>
< The date (and optionally time) when the concept map was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the concept map changes. The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the concept map. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)date:dateTime>?
< The name of the organization or individual responsible for the release and ongoing maintenance of the concept map. Usually an organization but may be an individual. The publisher (or steward) of the concept map is the organization or individual primarily responsible for the maintenance and upkeep of the concept map. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the concept map. This item SHOULD be populated unless the information is available from context.; (xsd)publisher:string>?
[]< Contact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)contact:ContactDetail>*
< A free text natural language description of the concept map from a consumer's perspective. The description is not intended to describe the semantics of the concept map. The description should capture its intended use, which is needed for ensuring integrity for its use in models across future changes.; (xsd)description:markdown>
[]< The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate concept map instances. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.; (xsd)useContext:UsageContext>*
[]< A legal or geographic region in which the concept map is intended to be used. It may be possible for the concept map to be used in jurisdictions other than those for which it was originally designed or intended.
DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.) Binding: jurisdiction (extensible, Countries and regions within which this artifact is targeted for use.); (xsd)jurisdiction:CodeableConcept>*
< Explanation of why this concept map is needed and why it has been designed as it has. This element does not describe the usage of the concept map. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this concept map.; (xsd)purpose:markdown>?
< A copyright statement relating to the concept map and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the concept map. Frequently the copyright differs between the concept map and codes that are included. The copyright statement should clearly differentiate between these when required.; (xsd)copyright:markdown>?
< A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved'). The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.; (xsd)copyrightLabel:string>?
< The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)approvalDate:date>?
< The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. If specified, this date follows the original approval date.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)lastReviewDate:date>?
< The period during which the ConceptMap content was or is planned to be in active use. The effective period for a ConceptMap determines when the content is applicable for usage and is independent of publication and review dates. For example, a map intended to be used for the year 2016 might be published in 2015.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)effectivePeriod:Period>?
[]< Descriptions related to the content of the ConceptMap. Topics provide a high-level categorization as well as keywords for the ConceptMap that can be useful for filtering and searching. DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'topic' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#topic and useContext.valueCodeableConcept indicating the topic) Binding: definition-topic (example, ); (xsd)topic:CodeableConcept>*
[]< An individiual or organization primarily involved in the creation and maintenance of the ConceptMap.; (xsd)author:ContactDetail>*
[]< An individual or organization primarily responsible for internal coherence of the ConceptMap.; (xsd)editor:ContactDetail>*
[]< An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the ConceptMap. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)reviewer:ContactDetail>*
[]< An individual or organization asserted by the publisher to be responsible for officially endorsing the ConceptMap for use in some setting. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)endorser:ContactDetail>*
[]< Related artifacts such as additional documentation, justification, dependencies, bibliographic references, and predecessor and successor artifacts. Each related artifact is either an attachment, or a reference to another resource, but not both.; (xsd)relatedArtifact:RelatedArtifact>*
[]< A property defines a slot through which additional information can be provided about a map from source -> target. Properties may be used to supply for example, mapping priority, provenance, presentation hints, flag as experimental, and additional documentation. Multiple occurrences of ConceptMap.group.element.target.property may occur for a ConceptMap.property where ConceptMap.group.element.target.property.code is the same and the values in ConceptMap.group.element.target.property.value differ.; (xsd)property:shareableconceptmap.property>*
[]< An additionalAttribute defines an additional data element found in the source or target data model where the data will come from or be mapped to. Some mappings are based on data in addition to the source data element, where codes in multiple fields are combined to a single field (or vice versa). Additional attributes are used to define additional data elements where mapping data can be found. For an example, see [Specimen Type v2 -> SNOMED CT Mapping(conceptmap-example-specimen-type.html); (xsd)additionalAttribute:shareableconceptmap.additionalAttribute>*
< Identifier for the source value set that contains the concepts that are being mapped and provides context for the mappings. Limits the scope of the map to source codes (ConceptMap.group.element code or valueSet) that are members of this value set. Should be a version specific reference. URIs SHOULD be absolute. If there is no sourceScope or targetScope value set, there is no specified context for the map (not recommended). The sourceScope value set may select codes from either an explicit (standard or local) or implicit code system.; (xsd)sourceScope:(<uri>
|<ValueSet>)>?
< Identifier for the target value set that provides important context about how the mapping choices are made. Limits the scope of the map to target codes (ConceptMap.group.element.target code or valueSet) that are members of this value set. Should be a version specific reference. URIs SHOULD be absolute. If there is no sourceScope or targetScope value set, there is no specified context for the map (not recommended). The targetScope value set may select codes from either an explicit (standard or local) or implicit code system.; (xsd)targetScope:(<uri>
|<ValueSet>)>?
[]< A group of mappings that all have the same source and target system.; (xsd)group:shareableconceptmap.group>*
[]< Defines a knowledge representation level provided by this knowledge artifact.; (xsd)knowledgeRepresentationLevel:Extension>*🔗 An additionalAttribute defines an additional data element found in the source or target data model where the data will come from or be mapped to. Some mappings are based on data in addition to the source data element, where codes in multiple fields are combined to a single field (or vice versa). Additional attributes are used to define additional data elements where mapping data can be found. For an example, see [Specimen Type v2 -> SNOMED CT Mapping(conceptmap-example-specimen-type.html)shareableconceptmap.additionalAttribute(xsd)(doc)=
<#base:ConceptMap.additionalAttribute>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A code that is used to identify this additional data attribute. The code is used internally in ConceptMap.group.element.target.dependsOn.attribute and ConceptMap.group.element.target.product.attribute.; (xsd)code>
< Reference to the formal definition of the source/target data element. For elements defined by the FHIR specification, or using a FHIR logical model, the correct format is {canonical-url}#{element-id}.; (xsd)uri>?
< A description of the additional attribute and/or the data element it refers to - why it is defined, and how the value might be used in mappings, and a discussion of issues associated with the use of the data element.; (xsd)description:string>?
< The type of the source data contained in this concept map for this data element. When the source or target is not content defined by FHIR, some additional application logic might be required to map from the FHIR Datatype to the externally defined content Binding: conceptmap-attribute-type (required, The type of a mapping attribute value.); (xsd)type:code>🔗 A group of mappings that all have the same source and target system.shareableconceptmap.group(xsd)(doc)=
<#base:ConceptMap.group>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< An absolute URI that identifies the source system where the concepts to be mapped are defined. This is not needed if the source value set is specified and it contains concepts from only a single system.; (xsd)source:CodeSystem*>?
< An absolute URI that identifies the target system that the concepts will be mapped to. This is not needed if the target value set is specified and it contains concepts from only a single system. The group target may also be omitted if all of the target element relationship values are 'not-related-to'.; (xsd)target:CodeSystem*>?
[]< Mappings for an individual concept in the source to one or more concepts in the target. Generally, the ideal is that there would only be one mapping for each concept in the source value set, but a given concept may be mapped multiple times with different comments or dependencies.; (xsd)element:shareableconceptmap.group.element>+
< What to do when there is no mapping to a target concept from the source concept and ConceptMap.group.element.noMap is not true. This provides the "default" to be applied when there is no target concept mapping specified or the expansion of ConceptMap.group.element.target.valueSet is empty. The 'unmapped' element is ignored if a code is specified to have relationship = not-related-to or if ConceptMap.group.element.noMap = true.; (xsd)unmapped:shareableconceptmap.group.unmapped>?🔗 Mappings for an individual concept in the source to one or more concepts in the target. Generally, the ideal is that there would only be one mapping for each concept in the source value set, but a given concept may be mapped multiple times with different comments or dependencies.shareableconceptmap.group.element(xsd)(doc)=
<#base:ConceptMap.group.element>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Identity (code or path) or the element/item being mapped.; (xsd)code>?
< The display for the code. The display is only provided to help editors when editing the concept map. The display is ignored when processing the map.; (xsd)display:string>?
< The set of concepts from the ConceptMap.group.source code system which are all being mapped to the target as part of this mapping rule. If the value set expansion is empty then there are no source concepts to map in this rule.; (xsd)valueSet:ValueSet*>?
< If noMap = true this indicates that no mapping to a target concept exists for this source concept. If noMap = true, then the behavior of ConceptMap.group.unmapped (if present) does not apply.; (xsd)noMap:boolean>?
[]< A concept from the target value set that this concept maps to. Ideally there would only be one map, with an 'equivalent' mapping. But multiple maps are allowed for several narrower (i.e. source-is-broader-than-target) options, or to assert that other concepts are not related.; (xsd)target:shareableconceptmap.group.element.target>*🔗 A concept from the target value set that this concept maps to. Ideally there would only be one map, with an 'equivalent' mapping. But multiple maps are allowed for several narrower (i.e. source-is-broader-than-target) options, or to assert that other concepts are not related.shareableconceptmap.group.element.target(xsd)(doc)=
<#base:ConceptMap.group.element.target>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Identity (code or path) or the element/item that the map refers to.; (xsd)code>?
< The display for the code. The display is only provided to help editors when editing the concept map. The display is ignored when processing the map.; (xsd)display:string>?
< The set of concepts from the ConceptMap.group.target code system which are all being mapped to as part of this mapping rule. The effect of using this data element is the same as having multiple ConceptMap.group.element.target elements with one for each concept in the ConceptMap.group.element.target.valueSet value set. If the the value set expansion is empty then the source concept(s) are unmapped and the behavior of ConceptMap.group.unmapped (if present) applies.; (xsd)valueSet:ValueSet*>?
< The relationship between the source and target concepts. The relationship is read from source to target (e.g. source-is-narrower-than-target). This element is labeled as a modifier because it may indicate that there is no mapping. Binding: concept-map-relationship (required, The relationship between concepts.); (xsd)relationship:code>
< A description of status/issues in mapping that conveys additional information not represented in the structured data.; (xsd)comment:string>?
[]< A property value for this source -> target mapping.; (xsd)property:shareableconceptmap.group.element.target.property>*
[]< A set of additional dependencies for this mapping to hold. This mapping is only applicable if the specified data attribute can be resolved, and it has the specified value.; (xsd)dependsOn:shareableconceptmap.group.element.target.dependsOn>*
[]< Product is the output of a ConceptMap that provides additional values that go in other attributes / data elemnts of the target data.; (xsd)product:ConceptMap.group.element.target.dependsOn>*🔗 A set of additional dependencies for this mapping to hold. This mapping is only applicable if the specified data attribute can be resolved, and it has the specified value.shareableconceptmap.group.element.target.dependsOn(xsd)(doc)=
<#base:ConceptMap.group.element.target.dependsOn>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A reference to the additional attribute that holds a value the map depends on.; (xsd)attribute:code>
(<valueBoolean:boolean>
|<valueCode:code>
|<valueCoding:Coding>
|<valueQuantity:Quantity>
|<valueString:string>)?
< This mapping applies if the data element value is a code from this value set.; (xsd)valueSet:ValueSet*>?🔗 A property value for this source -> target mapping.shareableconceptmap.group.element.target.property(xsd)(doc)=
<#base:ConceptMap.group.element.target.property>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A reference to a mapping property defined in ConceptMap.property.; (xsd)code>
(<valueBoolean:boolean>
|<valueCode:code>
|<valueCoding:Coding>
|<valueDateTime:dateTime>
|<valueDecimal:decimal>
|<valueInteger:integer>
|<valueString:string>)🔗 What to do when there is no mapping to a target concept from the source concept and ConceptMap.group.element.noMap is not true. This provides the "default" to be applied when there is no target concept mapping specified or the expansion of ConceptMap.group.element.target.valueSet is empty. The 'unmapped' element is ignored if a code is specified to have relationship = not-related-to or if ConceptMap.group.element.noMap = true.shareableconceptmap.group.unmapped(xsd)(doc)=
<#base:ConceptMap.group.unmapped>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Defines which action to take if there is no match for the source concept in the target system designated for the group. One of 3 actions are possible: use the unmapped source code (this is useful when doing a mapping between versions, and only a few codes have changed), use a fixed code (a default code), or alternatively, a reference to a different concept map can be provided (by canonical URL). Binding: conceptmap-unmapped-mode (required, Defines which action to take if there is no match in the group.); (xsd)mode:code>
< The fixed code to use when the mode = 'fixed' - all unmapped codes are mapped to a single fixed code.; (xsd)code>?
< The display for the code. The display is only provided to help editors when editing the concept map. The display is ignored when processing the map.; (xsd)display:string>?
< The set of fixed codes to use when the mode = 'fixed' - all unmapped codes are mapped to each of the fixed codes.; (xsd)valueSet:ValueSet*>?
< The default relationship value to apply between the source and target concepts when the source code is unmapped and the mode is 'fixed' or 'use-source-code'. This element is labeled as a modifier because it may indicate that there is no mapping. Binding: concept-map-relationship (required, The default relationship value to apply between the source and target concepts when no concept mapping is specified.); (xsd)relationship:code>?
< The canonical reference to an additional ConceptMap resource instance to use for mapping if this ConceptMap resource contains no matching mapping for the source concept.; (xsd)otherMap:ConceptMap*>?🔗 A property defines a slot through which additional information can be provided about a map from source -> target. Properties may be used to supply for example, mapping priority, provenance, presentation hints, flag as experimental, and additional documentation. Multiple occurrences of ConceptMap.group.element.target.property may occur for a ConceptMap.property where ConceptMap.group.element.target.property.code is the same and the values in ConceptMap.group.element.target.property.value differ.shareableconceptmap.property(xsd)(doc)=
<#base:ConceptMap.property>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A code that is used to identify the property. The code is used internally (in ConceptMap.group.element.target.property.code) and also in the $translate operation.; (xsd)code>
< Reference to the formal meaning of the property.; (xsd)uri>?
< A description of the property - why it is defined, and how its value might be used.; (xsd)description:string>?
< The type of the property value. Binding: conceptmap-property-type (required, The type of a property value.); (xsd)type:code>
< The CodeSystem that defines the codes from which values of type ```code``` in property values.; (xsd)system:CodeSystem*>?🔗 The Library resource is a general-purpose container for knowledge asset definitions. It can be used to describe and expose existing knowledge assets such as logic libraries and information model descriptions, as well as to describe a collection of knowledge assets.shareablelibrary(xsd)(doc)=
<#base:Library>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< An Extension; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< An absolute URI that is used to identify this library when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this library is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the library is stored on different servers. Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.
The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions).
In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.; (xsd)url:uri>
[]< A formal identifier that is used to identify this library when it is represented in other formats, or referenced in a specification, model, design or an instance. e.g. CMS or NQF identifiers for a measure artifact. Note that at least one identifier is required for non-experimental active artifacts. Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this library outside of FHIR, where it is not possible to use the logical URI.; (xsd)identifier:Identifier>*
< The identifier that is used to identify this version of the library when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the library author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts. There may be different library instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the library with the format [url]|[version]. The version SHOULD NOT contain a '#' - see [Business Version](resource.html#bv-format).; (xsd)version:string>
< Indicates the mechanism used to compare versions to determine which is more current. If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined. Binding: version-algorithm (extensible, ); (xsd)versionAlgorithm:(<Coding>
|<string>)>?
< A natural language name identifying the library. This name should be usable as an identifier for the module by machine processing applications such as code generation. The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.; (xsd)name:string>?
< A short, descriptive, user-friendly title for the library. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.; (xsd)title:string>
< An explanatory or alternate title for the library giving additional information about its content.; (xsd)subtitle:string>?
< The status of this library. Enables tracking the life-cycle of the content. Allows filtering of libraries that are appropriate for use vs. not.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization). Binding: publication-status (required, The lifecycle status of an artifact.); (xsd)status:code>
< A Boolean value to indicate that this library is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. Allows filtering of librarys that are appropriate for use versus not.; (xsd)experimental:boolean>?
< Identifies the type of library such as a Logic Library, Model Definition, Asset Collection, or Module Definition. Binding: library-type (extensible, The type of knowledge asset this library contains.); (xsd)type:CodeableConcept>
< A code or group definition that describes the intended subject of the contents of the library. Binding: participant-resource-types (extensible, The possible types of subjects for a library (E.g. Patient, Practitioner, Organization, Location, etc.).); (xsd)subject:(<CodeableConcept>
|<Group>)>?
< The date (and optionally time) when the library was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the library changes. The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the library. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)date:dateTime>?
< The name of the organization or individual responsible for the release and ongoing maintenance of the library. Usually an organization but may be an individual. The publisher (or steward) of the library is the organization or individual primarily responsible for the maintenance and upkeep of the library. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the library. This item SHOULD be populated unless the information is available from context.; (xsd)publisher:string>?
[]< Contact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)contact:ContactDetail>*
< A free text natural language description of the library from a consumer's perspective. This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the library as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the library is presumed to be the predominant language in the place the library was created).; (xsd)description:markdown>
[]< The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate library instances. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.; (xsd)useContext:UsageContext>*
[]< A legal or geographic region in which the library is intended to be used. It may be possible for the library to be used in jurisdictions other than those for which it was originally designed or intended.
DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.) Binding: jurisdiction (extensible, Countries and regions within which this artifact is targeted for use.); (xsd)jurisdiction:CodeableConcept>*
< Explanation of why this library is needed and why it has been designed as it has. This element does not describe the usage of the library. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this library.; (xsd)purpose:markdown>?
< A detailed description of how the library is used from a clinical perspective.; (xsd)usage:markdown>?
< A copyright statement relating to the library and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the library. The short copyright declaration (e.g. (c) '2015+ xyz organization' should be sent in the copyrightLabel element.; (xsd)copyright:markdown>?
< A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved'). The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.; (xsd)copyrightLabel:string>?
< The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)approvalDate:date>?
< The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. If specified, this date follows the original approval date.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)lastReviewDate:date>?
< The period during which the library content was or is planned to be in active use. The effective period for a library determines when the content is applicable for usage and is independent of publication and review dates. For example, a library intended to be used for the year 2016 might be published in 2015.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)effectivePeriod:Period>?
[]< Descriptive topics related to the content of the library. Topics provide a high-level categorization of the library that can be useful for filtering and searching. DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'topic' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#topic and useContext.valueCodeableConcept indicating the topic) Binding: definition-topic (example, High-level categorization of the definition, used for searching, sorting, and filtering.); (xsd)topic:CodeableConcept>*
[]< An individiual or organization primarily involved in the creation and maintenance of the content.; (xsd)author:ContactDetail>*
[]< An individual or organization primarily responsible for internal coherence of the content.; (xsd)editor:ContactDetail>*
[]< An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the content. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)reviewer:ContactDetail>*
[]< An individual or organization asserted by the publisher to be responsible for officially endorsing the content for use in some setting. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)endorser:ContactDetail>*
[]< Related artifacts such as additional documentation, justification, or bibliographic references. Each related artifact is either an attachment, or a reference to another resource, but not both.; (xsd)relatedArtifact:RelatedArtifact>*
[]< The parameter element defines parameters used by the library.; (xsd)parameter:ParameterDefinition>*
[]< Describes a set of data that must be provided in order to be able to successfully perform the computations defined by the library.; (xsd)dataRequirement:DataRequirement>*
[]< The content of the library as an Attachment. The content may be a reference to a url, or may be directly embedded as a base-64 string. Either way, the contentType of the attachment determines how to interpret the content.; (xsd)content:Attachment>*
[]< Defines a knowledge capability afforded by this knowledge artifact.; (xsd)knowledgeCapability:Extension>*
[]< Defines a knowledge representation level provided by this knowledge artifact.; (xsd)knowledgeRepresentationLevel:Extension>*
[]< A comment containing additional documentation, a review comment, usage guidance, or other relevant information from a particular user.; (xsd)artifactComment:Extension>*🔗 The Measure resource provides the definition of a quality measure.shareablemeasure(xsd)(doc)=
<#base:Measure>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< An Extension; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< An absolute URI that is used to identify this measure when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this measure is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the measure is stored on different servers. Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.
The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions).
In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.; (xsd)url:uri>
[]< A formal identifier that is used to identify this measure when it is represented in other formats, or referenced in a specification, model, design or an instance. Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this measure outside of FHIR, where it is not possible to use the logical URI.; (xsd)identifier:Identifier>*
< The identifier that is used to identify this version of the measure when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the measure author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts. There may be different measure instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the measure with the format [url]|[version]. The version SHOULD NOT contain a '#' - see [Business Version](resource.html#bv-format).; (xsd)version:string>
< Indicates the mechanism used to compare versions to determine which is more current. If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined. Binding: version-algorithm (extensible, ); (xsd)versionAlgorithm:(<Coding>
|<string>)>?
< A natural language name identifying the measure. This name should be usable as an identifier for the module by machine processing applications such as code generation. The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.; (xsd)name:string>?
< A short, descriptive, user-friendly title for the measure. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.; (xsd)title:string>
< An explanatory or alternate title for the measure giving additional information about its content.; (xsd)subtitle:string>?
< The status of this measure. Enables tracking the life-cycle of the content. Allows filtering of measures that are appropriate for use versus not.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization). Binding: publication-status (required, The lifecycle status of an artifact.); (xsd)status:code>
< A Boolean value to indicate that this measure is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. Allows filtering of measures that are appropriate for use versus not.; (xsd)experimental:boolean>?
< The intended subjects for the measure. If this element is not provided, a Patient subject is assumed, but the subject of the measure can be anything. The subject of the measure is critical in interpreting the criteria definitions, as the logic in the measures is evaluated with respect to a particular subject. This corresponds roughly to the notion of a Compartment in that it limits what content is available based on its relationship to the subject. In CQL, this corresponds to the context declaration. Binding: participant-resource-types (extensible, The possible types of subjects for a measure (E.g. Patient, Practitioner, Organization, Location, etc.).); (xsd)subject:(<CodeableConcept>
|<Group>)>?
< The population basis specifies the type of elements in the population. For a subject-based measure, this is boolean (because the subject and the population basis are the same, and the population criteria define yes/no values for each individual in the population). For measures that have a population basis that is different than the subject, this element specifies the type of the population basis. For example, an encounter-based measure has a subject of Patient and a population basis of Encounter, and the population criteria all return lists of Encounters. For a subject-based measure, the population basis is simply boolean; all the criteria are expressed as true/false conditions that determine membership of an individual case in the population. For non-subject-based measures, the population basis can be any resource type, and the criteria are queries that return the subject's contribution to the population as a list of that resource type. For example, for a procedure-based measure, the population criteria would return lists of procedures that should be included in each population. Binding: fhir-types (required, ); (xsd)basis:code>?
< The date (and optionally time) when the measure was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the measure changes. The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the measure. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)date:dateTime>?
< The name of the organization or individual responsible for the release and ongoing maintenance of the measure. Usually an organization but may be an individual. The publisher (or steward) of the measure is the organization or individual primarily responsible for the maintenance and upkeep of the measure. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the measure. This item SHOULD be populated unless the information is available from context.; (xsd)publisher:string>?
[]< Contact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)contact:ContactDetail>*
< A free text natural language description of the measure from a consumer's perspective. This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the measure as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the measure is presumed to be the predominant language in the place the measure was created).; (xsd)description:markdown>
[]< The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate measure instances. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.; (xsd)useContext:UsageContext>*
[]< A legal or geographic region in which the measure is intended to be used. It may be possible for the measure to be used in jurisdictions other than those for which it was originally designed or intended.
DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.) Binding: jurisdiction (extensible, Countries and regions within which this artifact is targeted for use.); (xsd)jurisdiction:CodeableConcept>*
< Explanation of why this measure is needed and why it has been designed as it has. This element does not describe the usage of the measure. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this measure.; (xsd)purpose:markdown>?
< A detailed description, from a clinical perspective, of how the measure is used. This metadata element was typically referred to as Guidance in HQMF; (xsd)usage:markdown>?
< A copyright statement relating to the measure and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the measure. The short copyright declaration (e.g. (c) '2015+ xyz organization' should be sent in the copyrightLabel element.; (xsd)copyright:markdown>?
< A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved'). The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.; (xsd)copyrightLabel:string>?
< The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)approvalDate:date>?
< The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. If specified, this date follows the original approval date.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)lastReviewDate:date>?
< The period during which the measure content was or is planned to be in active use. The effective period for a measure determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 might be published in 2015.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)effectivePeriod:Period>?
[]< Descriptive topics related to the content of the measure. Topics provide a high-level categorization grouping types of measures that can be useful for filtering and searching. DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'topic' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#topic and useContext.valueCodeableConcept indicating the topic) Binding: definition-topic (example, High-level categorization of the definition, used for searching, sorting, and filtering.); (xsd)topic:CodeableConcept>*
[]< An individiual or organization primarily involved in the creation and maintenance of the content.; (xsd)author:ContactDetail>*
[]< An individual or organization primarily responsible for internal coherence of the content.; (xsd)editor:ContactDetail>*
[]< An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the content. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)reviewer:ContactDetail>*
[]< An individual or organization asserted by the publisher to be responsible for officially endorsing the content for use in some setting. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)endorser:ContactDetail>*
[]< Related artifacts such as additional documentation, justification, or bibliographic references. Each related artifact is either an attachment, or a reference to another resource, but not both.; (xsd)relatedArtifact:RelatedArtifact>*
[]< A reference to a Library resource containing the formal logic used by the measure.; (xsd)library:Library*>*
< Notices and disclaimers regarding the use of the measure or related to intellectual property (such as code systems) referenced by the measure.; (xsd)disclaimer:markdown>?
< Indicates how the calculation is performed for the measure, including proportion, ratio, continuous-variable, and cohort. The value set is extensible, allowing additional measure scoring types to be represented. Binding: http://terminology.hl7.org/ValueSet/measure-scoring (extensible, The scoring type of the measure.); (xsd)scoring:CodeableConcept>?
< Defines the expected units of measure for the measure score. This element SHOULD be specified as a UCUM unit. When this element is specified, implementations are expected to report measure scores in the specified units. Note that this may involve unit conversion if the expected units are different than the units of the resulting score calculation. In this case, unit conversions SHALL be performed according to the unit conversion semantics specified by UCUM. Binding: measure-scoring-unit (example, ); (xsd)scoringUnit:CodeableConcept>?
< If this is a composite measure, the scoring method used to combine the component measures to determine the composite score. Binding: composite-measure-scoring (extensible, The composite scoring method of the measure.); (xsd)compositeScoring:CodeableConcept>?
[]< Indicates whether the measure is used to examine a process, an outcome over time, a patient-reported outcome, or a structure measure such as utilization. Binding: measure-type (extensible, The type of measure (includes codes from 2.16.840.1.113883.1.11.20368).); (xsd)type:CodeableConcept>*
< A description of the risk adjustment factors that may impact the resulting score for the measure and how they may be accounted for when computing and reporting measure results. Describes the method of adjusting for clinical severity and conditions present at the start of care that can influence patient outcomes for making valid comparisons of outcome measures across providers. Indicates whether a measure is subject to the statistical process for reducing, removing, or clarifying the influences of confounding factors to allow for more useful comparisons.; (xsd)riskAdjustment:markdown>?
< Describes how to combine the information calculated, based on logic in each of several populations, into one summarized result. The measure rate for an organization or clinician is based upon the entities’ aggregate data and summarizes the performance of the entity over a given time period (e.g., monthly, quarterly, yearly). The aggregated data are derived from the results of a specific measure algorithm and, if appropriate, the application of specific risk adjustment models. Can also be used to describe how to risk adjust the data based on supplemental data elements described in the eMeasure (e.g., pneumonia hospital measures antibiotic selection in the ICU versus non-ICU and then the roll-up of the two). This could be applied to aggregated cohort measure definitions (e.g., CDC's aggregate reporting for TB at the state level).; (xsd)rateAggregation:markdown>?
< Provides a succinct statement of the need for the measure. Usually includes statements pertaining to importance criterion: impact, gap in care, and evidence.; (xsd)rationale:markdown>?
< Provides a summary of relevant clinical guidelines or other clinical recommendations supporting the measure.; (xsd)clinicalRecommendationStatement:markdown>?
< Information on whether an increase or decrease in score is the preferred result (e.g., a higher score indicates better quality OR a lower score indicates better quality OR quality is within a range). Binding: measure-improvement-notation (required, Observation values that indicate what change in a measurement value or score is indicative of an improvement in the measured item or scored issue.); (xsd)improvementNotation:CodeableConcept>?
[]< Provides a description of an individual term used within the measure.; (xsd)term:shareablemeasure.term>*
< Additional guidance for the measure including how it can be used in a clinical context, and the intent of the measure. NOTE: This element is deprecated in favor of the usage element; (xsd)guidance:markdown>?
[]< A group of population criteria for the measure.; (xsd)group:shareablemeasure.group>*
[]< The supplemental data criteria for the measure report, specified as either the name of a valid CQL expression within a referenced library, or a valid FHIR Resource Path. Note that supplemental data are reported as resources for each patient and referenced in the supplementalData element of the MeasureReport. If the supplementalData expression results in a value other than a resource, it is reported using an Observation resource, typically contained in the resulting MeasureReport. See the MeasureReport resource and the Quality Reporting topic for more information.; (xsd)supplementalData:shareablemeasure.supplementalData>*
[]< Defines a knowledge capability afforded by this knowledge artifact.; (xsd)knowledgeCapability:Extension>*
[]< Defines a knowledge representation level provided by this knowledge artifact.; (xsd)knowledgeRepresentationLevel:Extension>*
[]< A comment containing additional documentation, a review comment, usage guidance, or other relevant information from a particular user.; (xsd)artifactComment:Extension>*🔗 A group of population criteria for the measure.shareablemeasure.group(xsd)(doc)=
<#base:Measure.group>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< An identifier that is unique within the Measure allowing linkage to the equivalent item in a MeasureReport resource. This ''can'' be a meaningful identifier (e.g. a LOINC code) but is not intended to have any meaning. GUIDs or sequential numbers are appropriate here.
LinkIds can have whitespaces and slashes by design. Tooling should not rely on linkIds being valid XHTML element IDs, and should not directly embed them as such; (xsd)linkId:string>?
< Indicates a meaning for the group. This can be as simple as a unique identifier, or it can establish meaning in a broader context by drawing from a terminology, allowing groups to be correlated across measures. Binding: measure-group-example (example, Example of measure groups.); (xsd)code:CodeableConcept>?
< The human readable description of this population group.; (xsd)description:markdown>?
[]< Indicates whether the measure is used to examine a process, an outcome over time, a patient-reported outcome, or a structure measure such as utilization. When specified at the group level, defines the measure type for this specific group. If not specified, the measureType of the group is determined by the root type element Binding: measure-type (extensible, ); (xsd)type:CodeableConcept>*
< The intended subjects for the measure. If this element is not provided, a Patient subject is assumed, but the subject of the measure can be anything. The subject of the measure is critical in interpreting the criteria definitions, as the logic in the measures is evaluated with respect to a particular subject. This corresponds roughly to the notion of a Compartment in that it limits what content is available based on its relationship to the subject. In CQL, this corresponds to the context declaration. Binding: participant-resource-types (extensible, The possible types of subjects for a measure (E.g. Patient, Practitioner, Organization, Location, etc.).); (xsd)subject:(<CodeableConcept>
|<Group>)>?
< The population basis specifies the type of elements in the population. For a subject-based measure, this is boolean (because the subject and the population basis are the same, and the population criteria define yes/no values for each individual in the population). For measures that have a population basis that is different than the subject, this element specifies the type of the population basis. For example, an encounter-based measure has a subject of Patient and a population basis of Encounter, and the population criteria all return lists of Encounters. When specified at the group level, defines the population basis for this specific group. If not specified, the basis for the group is determined by the root basis element Binding: fhir-types (required, ); (xsd)basis:code>?
< Indicates how the calculation is performed for the measure, including proportion, ratio, continuous-variable, and cohort. The value set is extensible, allowing additional measure scoring types to be represented. When specified at the group level, defines the scoring for this specific group. If not specified, scoring for this group is determined by the root scoring element Binding: http://terminology.hl7.org/ValueSet/measure-scoring (extensible, ); (xsd)scoring:CodeableConcept>?
< Defines the expected units of measure for the measure score. This element SHOULD be specified as a UCUM unit. When specified at the group level, this defines the scoringUnit for this specific group. If not specified, the scoringUnit for this group is determined by the root scoringUnit element. As with the root element, when this element is specified, implementations are expected to report measure scores in the specified units. Note that this may involve unit conversion if the expected units are different than the units of the resulting score calculation. In this case, unit conversions SHALL be performed according to the unit conversion semantics specified by UCUM. Binding: measure-scoring-unit (example, ); (xsd)scoringUnit:CodeableConcept>?
< Describes how to combine the information calculated, based on logic in each of several populations, into one summarized result. The measure rate for an organization or clinician is based upon the entities’ aggregate data and summarizes the performance of the entity over a given time period (e.g., monthly, quarterly, yearly). The aggregated data are derived from the results of a specific measure algorithm and, if appropriate, the application of specific risk adjustment models. Can also be used to describe how to risk adjust the data based on supplemental data elements described in the eMeasure (e.g., pneumonia hospital measures antibiotic selection in the ICU versus non-ICU and then the roll-up of the two). This could be applied to aggregated cohort measure definitions (e.g., CDC's aggregate reporting for TB at the state level).; (xsd)rateAggregation:markdown>?
< Information on whether an increase or decrease in score is the preferred result (e.g., a higher score indicates better quality OR a lower score indicates better quality OR quality is within a range). When specified at the group level, this element defines the improvementNotation for this specific group. If not specified, improvementNotation for this group is determined by the root improvementNotation element Binding: measure-improvement-notation (required, ); (xsd)improvementNotation:CodeableConcept>?
[]< A reference to a Library resource containing the formal logic used by the measure group.; (xsd)library:Library*>*
[]< A population criteria for the measure.; (xsd)population:shareablemeasure.group.population>*
[]< The stratifier criteria for the measure report, specified as either the name of a valid CQL expression defined within a referenced library or a valid FHIR Resource Path.; (xsd)stratifier:shareablemeasure.group.stratifier>*🔗 A population criteria for the measure.shareablemeasure.group.population(xsd)(doc)=
<#base:Measure.group.population>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< An identifier that is unique within the Measure allowing linkage to the equivalent population in a MeasureReport resource. This ''can'' be a meaningful identifier (e.g. a LOINC code) but is not intended to have any meaning. GUIDs or sequential numbers are appropriate here.
LinkIds can have whitespaces and slashes by design. Tooling should not rely on linkIds being valid XHTML element IDs, and should not directly embed them as such; (xsd)linkId:string>?
< The type of population criteria. Binding: measure-population (extensible, The type of population.); (xsd)code:CodeableConcept>?
< The human readable description of this population criteria.; (xsd)description:markdown>?
< An expression that specifies the criteria for the population, typically the name of an expression in a library. In the case of a continuous-variable or ratio measure, this may be the name of a function that calculates the value of the individual observation for each patient or event in the population. For these types of measures, individual observations are reported as observation resources included in the evaluatedResources bundle for each patient. See the MeasureReport resource or the Quality Reporting topic for more information.; (xsd)criteria:Expression>?
< A Group resource that defines this population as a set of characteristics. Note that this approach can only be used for measures where the basis is of the same type as the populations (e.g. a Patient-based measure, rather than an Encounter-based measure). In addition, the referenced Group resource SHALL be a definitional (as opposed to an actual) group.; (xsd)groupDefinition:Group*>?
< The id of a population element in this measure that provides the input for this population criteria. In most cases, the scoring structure of the measure implies specific relationships (e.g. the Numerator uses the Denominator as the source in a proportion scoring). In some cases, however, multiple possible choices exist and must be resolved explicitly. For example in a ratio measure with multiple initial populations, the denominator must specify which population should be used as the starting point.; (xsd)inputPopulationId:string>?
< Specifies which method should be used to aggregate measure observation values. For most scoring types, this is implied by scoring (e.g. a proportion measure counts members of the populations). For continuous variables, however, this information must be specified to ensure correct calculation. Binding: measure-aggregate-method (extensible, ); (xsd)aggregateMethod:CodeableConcept>?🔗 The stratifier criteria for the measure report, specified as either the name of a valid CQL expression defined within a referenced library or a valid FHIR Resource Path.shareablemeasure.group.stratifier(xsd)(doc)=
<#base:Measure.group.stratifier>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< An identifier that is unique within the Measure allowing linkage to the equivalent item in a MeasureReport resource. This ''can'' be a meaningful identifier (e.g. a LOINC code) but is not intended to have any meaning. GUIDs or sequential numbers are appropriate here.
LinkIds can have whitespaces and slashes by design. Tooling should not rely on linkIds being valid XHTML element IDs, and should not directly embed them as such; (xsd)linkId:string>?
< Indicates a meaning for the stratifier. This can be as simple as a unique identifier, or it can establish meaning in a broader context by drawing from a terminology, allowing stratifiers to be correlated across measures. Binding: measure-stratifier-example (example, Meaning of the stratifier.); (xsd)code:CodeableConcept>?
< The human readable description of this stratifier criteria.; (xsd)description:markdown>?
< An expression that specifies the criteria for the stratifier. This is typically the name of an expression defined within a referenced library, but it may also be a path to a stratifier element.; (xsd)criteria:Expression>?
< A Group resource that defines this population as a set of characteristics. Note that this approach can only be used for measures where the basis is of the same type as the populations (e.g. a Patient-based measure, rather than an Encounter-based measure). In addition, the referenced Group SHALL be a definitional (as opposed to an actual) group.; (xsd)groupDefinition:Group*>?
[]< A component of the stratifier criteria for the measure report, specified as either the name of a valid CQL expression defined within a referenced library or a valid FHIR Resource Path. Stratifiers are defined either as a single criteria, or as a set of component criteria.; (xsd)component:shareablemeasure.group.stratifier.component>*🔗 A component of the stratifier criteria for the measure report, specified as either the name of a valid CQL expression defined within a referenced library or a valid FHIR Resource Path. Stratifiers are defined either as a single criteria, or as a set of component criteria.shareablemeasure.group.stratifier.component(xsd)(doc)=
<#base:Measure.group.stratifier.component>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< An identifier that is unique within the Measure allowing linkage to the equivalent item in a MeasureReport resource. This ''can'' be a meaningful identifier (e.g. a LOINC code) but is not intended to have any meaning. GUIDs or sequential numbers are appropriate here.
LinkIds can have whitespaces and slashes by design. Tooling should not rely on linkIds being valid XHTML element IDs, and should not directly embed them as such; (xsd)linkId:string>?
< Indicates a meaning for the stratifier component. This can be as simple as a unique identifier, or it can establish meaning in a broader context by drawing from a terminology, allowing stratifiers to be correlated across measures. Binding: measure-stratifier-example (example, Meaning of the stratifier.); (xsd)code:CodeableConcept>?
< The human readable description of this stratifier criteria component.; (xsd)description:markdown>?
< An expression that specifies the criteria for this component of the stratifier. This is typically the name of an expression defined within a referenced library, but it may also be a path to a stratifier element.; (xsd)criteria:Expression>?
< A Group resource that defines this population as a set of characteristics. Note that this approach can only be used for measures where the basis is of the same type as the populations (e.g. a Patient-based measure, rather than an Encounter-based measure). In addition, the referenced Group SHALL be a definitional (as opposed to an actual) group.; (xsd)groupDefinition:Group*>?🔗 The supplemental data criteria for the measure report, specified as either the name of a valid CQL expression within a referenced library, or a valid FHIR Resource Path. Note that supplemental data are reported as resources for each patient and referenced in the supplementalData element of the MeasureReport. If the supplementalData expression results in a value other than a resource, it is reported using an Observation resource, typically contained in the resulting MeasureReport. See the MeasureReport resource and the Quality Reporting topic for more information.shareablemeasure.supplementalData(xsd)(doc)=
<#base:Measure.supplementalData>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< An identifier that is unique within the Measure allowing linkage to the equivalent item in a MeasureReport resource. This ''can'' be a meaningful identifier (e.g. a LOINC code) but is not intended to have any meaning. GUIDs or sequential numbers are appropriate here.
LinkIds can have whitespaces and slashes by design. Tooling should not rely on linkIds being valid XHTML element IDs, and should not directly embed them as such; (xsd)linkId:string>?
< Indicates a meaning for the supplemental data. This can be as simple as a unique identifier, or it can establish meaning in a broader context by drawing from a terminology, allowing supplemental data to be correlated across measures. Binding: measure-supplemental-data-example (example, Meaning of the supplemental data.); (xsd)code:CodeableConcept>?
[]< An indicator of the intended usage for the supplemental data element. Supplemental data indicates the data is additional information requested to augment the measure information. Risk adjustment factor indicates the data is additional information used to calculate risk adjustment factors when applying a risk model to the measure calculation. Binding: measure-data-usage (extensible, The intended usage for supplemental data elements in the measure.); (xsd)usage:CodeableConcept>*
< The human readable description of this supplemental data.; (xsd)description:markdown>?
< The criteria for the supplemental data. This is typically the name of a valid expression defined within a referenced library, but it may also be a path to a specific data element. The criteria defines the data to be returned for this element.; (xsd)criteria:Expression>🔗 Provides a description of an individual term used within the measure.shareablemeasure.term(xsd)(doc)=
<#base:Measure.term>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A codeable representation of the defined term. Binding: measure-definition-example (example, Codeable representations of measure definition terms.); (xsd)code:CodeableConcept>?
< Provides a definition for the term as used within the measure.; (xsd)definition:markdown>?🔗 A curated namespace that issues unique symbols within that namespace for the identification of concepts, people, devices, etc. Represents a "System" used within the Identifier and Coding data types.shareablenamingsystem(xsd)(doc)=
<#base:NamingSystem>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< An Extension; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< An absolute URI that is used to identify this naming system when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this naming system is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the naming system is stored on different servers. Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.
The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions).
In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.; (xsd)url:uri>
[]< A formal identifier that is used to identify this naming system when it is represented in other formats, or referenced in a specification, model, design or an instance. Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this naming system outside of FHIR, where it is not possible to use the logical URI.; (xsd)identifier:Identifier>*
< The identifier that is used to identify this version of the naming system when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the naming system author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. There may be different naming system instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the naming system with the format [url]|[version]. The version SHOULD NOT contain a '#' - see [Business Version](resource.html#bv-format).; (xsd)version:string>
< Indicates the mechanism used to compare versions to determine which NamingSystem is more current. If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined. Binding: version-algorithm (extensible, ); (xsd)versionAlgorithm:(<Coding>
|<string>)>?
< A natural language name identifying the naming system. This name should be usable as an identifier for the module by machine processing applications such as code generation. The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.The"symbolic name" for an OID would be captured as an extension.; (xsd)name:string>
< A short, descriptive, user-friendly title for the naming system. This title does not need to be machine-processing friendly and may contain punctuation, white-space, etc.; (xsd)title:string>
< The status of this naming system. Enables tracking the life-cycle of the content. Allows filtering of naming systems that are appropriate for use versus not.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization). Binding: publication-status (required, The lifecycle status of an artifact.); (xsd)status:code>
< Indicates the purpose for the naming system - what kinds of things does it make unique? Binding: namingsystem-type (required, Identifies the purpose of the naming system.); (xsd)kind:code>
< A Boolean value to indicate that this naming system is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. Allows filtering of naming systems that are appropriate for use versus not.; (xsd)experimental:boolean>?
< The date (and optionally time) when the naming system was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the naming system changes. The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the naming system. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)date:dateTime>
< The name of the organization or individual responsible for the release and ongoing maintenance of the naming system. Usually an organization but may be an individual. The publisher (or steward) of the naming system is the organization or individual primarily responsible for the maintenance and upkeep of the naming system. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the naming system. This item SHOULD be populated unless the information is available from context.; (xsd)publisher:string>?
[]< Contact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)contact:ContactDetail>*
< The name of the organization that is responsible for issuing identifiers or codes for this namespace and ensuring their non-collision. This is the primary organization. Responsibility for some aspects of a namespace may be delegated.; (xsd)responsible:string>?
< Categorizes a naming system for easier search by grouping related naming systems. This will most commonly be used for identifier namespaces, but categories could potentially be useful for code systems and authorities as well. Binding: namingsystem-identifier-system-type (preferred, A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.); (xsd)type:CodeableConcept>?
< A free text natural language description of the naming system from a consumer's perspective. Details about what the namespace identifies including scope, granularity, version labeling, etc. This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the naming system as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the naming system is presumed to be the predominant language in the place the naming system was created).; (xsd)description:markdown>
[]< The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate naming system instances. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.; (xsd)useContext:UsageContext>*
[]< A legal or geographic region in which the naming system is intended to be used. It may be possible for the naming system to be used in jurisdictions other than those for which it was originally designed or intended.
DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.) Binding: jurisdiction (extensible, Countries and regions within which this artifact is targeted for use.); (xsd)jurisdiction:CodeableConcept>*
< Explanation of why this naming system is needed and why it has been designed as it has. This element does not describe the usage of the code system. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this code system.; (xsd)purpose:markdown>?
< A copyright statement relating to the naming system and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the naming system.; (xsd)copyright:markdown>?
< A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved'). The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.; (xsd)copyrightLabel:string>?
< The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)approvalDate:date>?
< The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. If specified, this date follows the original approval date.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)lastReviewDate:date>?
< The period during which the NamingSystem content was or is planned to be in active use. The effective period for a NamingSystem determines when the content is applicable for usage and is independent of publication and review dates. For example, a NamingSystem intended to be used for the year 2016 might be published in 2015.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)effectivePeriod:Period>?
[]< Descriptions related to the content of the NamingSystem. Topics provide a high-level categorization as well as keywords for the NamingSystem that can be useful for filtering and searching. DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'topic' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#topic and useContext.valueCodeableConcept indicating the topic) Binding: definition-topic (example, ); (xsd)topic:CodeableConcept>*
[]< An individiual or organization primarily involved in the creation and maintenance of the NamingSystem.; (xsd)author:ContactDetail>*
[]< An individual or organization primarily responsible for internal coherence of the NamingSystem.; (xsd)editor:ContactDetail>*
[]< An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the NamingSystem. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)reviewer:ContactDetail>*
[]< An individual or organization asserted by the publisher to be responsible for officially endorsing the NamingSystem for use in some setting. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)endorser:ContactDetail>*
[]< Related artifacts such as additional documentation, justification, dependencies, bibliographic references, and predecessor and successor artifacts. Each related artifact is either an attachment, or a reference to another resource, but not both.; (xsd)relatedArtifact:RelatedArtifact>*
< Provides guidance on the use of the namespace, including the handling of formatting characters, use of upper vs. lower case, etc.; (xsd)usage:string>?
[]< Indicates how the system may be identified when referenced in electronic exchange. Multiple identifiers may exist, either due to duplicate registration, regional rules, needs of different communication technologies, etc.; (xsd)uniqueId:shareablenamingsystem.uniqueId>+
[]< Defines a knowledge representation level provided by this knowledge artifact.; (xsd)knowledgeRepresentationLevel:Extension>*🔗 Indicates how the system may be identified when referenced in electronic exchange. Multiple identifiers may exist, either due to duplicate registration, regional rules, needs of different communication technologies, etc.shareablenamingsystem.uniqueId(xsd)(doc)=
<#base:NamingSystem.uniqueId>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Identifies the unique identifier scheme used for this particular identifier. Different identifier types may be used in different types of communications (OIDs for v3, URIs for FHIR, etc.). Other includes RUIDs from v3, standard v2 code name strings, etc. Preferred identifiers for the same identifier type SHOULD NOT overlap by period. Binding: namingsystem-identifier-type (required, Identifies the style of unique identifier used to identify a namespace.); (xsd)type:code>
< The string that should be sent over the wire to identify the code system or identifier system. If the value is a URI intended for use as FHIR system identifier, the URI should not contain "\" or "?" or "," since this makes escaping very difficult.; (xsd)value:string>
< Indicates whether this identifier is the "preferred" identifier of this type.; (xsd)preferred:boolean>?
< Notes about the past or intended usage of this identifier. e.g. "must be used in Germany" or "was initially published in error with this value".; (xsd)comment:string>?
< Identifies the period of time over which this identifier is considered appropriate to refer to the naming system. Outside of this window, the identifier might be non-deterministic. Within a registry, a given identifier should only be "active" for a single namespace at a time. (Ideally, an identifier should only ever be associated with a single namespace across all time).
The nuance of identifier deprecation is not represented with a separate element. When a determination is made that an identifier should not be used, the validity period end date is updated with the date the identifier is deemed to be deprecated. The identifier should no longer be used once the period end date is reached.; (xsd)period:Period>?
< Indicates whether this identifier ie endorsed by the official owner of the associated naming system.; (xsd)authoritative:boolean>?🔗 This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical and non-clinical artifacts such as clinical decision support rules, order sets, protocols, and drug quality specifications.shareableplandefinition(xsd)(doc)=
<#base:PlanDefinition>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< An Extension; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< An absolute URI that is used to identify this plan definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this plan definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the plan definition is stored on different servers. Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.
The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions).
In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.; (xsd)url:uri>
[]< A formal identifier that is used to identify this plan definition when it is represented in other formats, or referenced in a specification, model, design or an instance. Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this plan definition outside of FHIR, where it is not possible to use the logical URI.; (xsd)identifier:Identifier>*
< The identifier that is used to identify this version of the plan definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the plan definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts. There may be different plan definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the plan definition with the format [url]|[version]. The version SHOULD NOT contain a '#' - see [Business Version](resource.html#bv-format).; (xsd)version:string>
< Indicates the mechanism used to compare versions to determine which is more current. If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined. Binding: version-algorithm (extensible, ); (xsd)versionAlgorithm:(<Coding>
|<string>)>?
< A natural language name identifying the plan definition. This name should be usable as an identifier for the module by machine processing applications such as code generation. The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.; (xsd)name:string>?
< A short, descriptive, user-friendly title for the plan definition. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.; (xsd)title:string>
< An explanatory or alternate title for the plan definition giving additional information about its content.; (xsd)subtitle:string>?
< A high-level category for the plan definition that distinguishes the kinds of systems that would be interested in the plan definition. Binding: plan-definition-type (extensible, The type of PlanDefinition.); (xsd)type:CodeableConcept>?
< The status of this plan definition. Enables tracking the life-cycle of the content. Allows filtering of plan definitions that are appropriate for use versus not.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization). Binding: publication-status (required, The lifecycle status of an artifact.); (xsd)status:code>
< A Boolean value to indicate that this plan definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. Allows filtering of plan definitions that are appropriate for use versus not.; (xsd)experimental:boolean>?
< A code, group definition, or canonical reference that describes or identifies the intended subject of the plan definition. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource. Note that the choice of canonical for the subject element was introduced in R4B to support pharmaceutical quality use cases. To ensure as much backwards-compatibility as possible, it is recommended to only use the new canonical type with these use cases. Binding: participant-resource-types (extensible, The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).); (xsd)subject:(<AdministrableProductDefinition>
|<CodeableConcept>
|<EvidenceVariable>
|<Group>
|<ManufacturedItemDefinition>
|<MedicinalProductDefinition>
|<PackagedProductDefinition>
|<SubstanceDefinition>)>?
< The date (and optionally time) when the plan definition was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the plan definition changes. The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the plan definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)date:dateTime>?
< The name of the organization or individual responsible for the release and ongoing maintenance of the plan definition. Usually an organization but may be an individual. The publisher (or steward) of the plan definition is the organization or individual primarily responsible for the maintenance and upkeep of the plan definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the plan definition. This item SHOULD be populated unless the information is available from context.; (xsd)publisher:string>?
[]< Contact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)contact:ContactDetail>*
< A free text natural language description of the plan definition from a consumer's perspective. This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the plan definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the plan definition is presumed to be the predominant language in the place the plan definition was created).; (xsd)description:markdown>
[]< The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate plan definition instances. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.; (xsd)useContext:UsageContext>*
[]< A legal or geographic region in which the plan definition is intended to be used. It may be possible for the plan definition to be used in jurisdictions other than those for which it was originally designed or intended.
DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.) Binding: jurisdiction (extensible, Countries and regions within which this artifact is targeted for use.); (xsd)jurisdiction:CodeableConcept>*
< Explanation of why this plan definition is needed and why it has been designed as it has. This element does not describe the usage of the plan definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this plan definition.; (xsd)purpose:markdown>?
< A detailed description of how the plan definition is used from a clinical perspective.; (xsd)usage:markdown>?
< A copyright statement relating to the plan definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the plan definition. The short copyright declaration (e.g. (c) '2015+ xyz organization' should be sent in the copyrightLabel element.; (xsd)copyright:markdown>?
< A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved'). The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.; (xsd)copyrightLabel:string>?
< The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)approvalDate:date>?
< The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. If specified, this date follows the original approval date.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)lastReviewDate:date>?
< The period during which the plan definition content was or is planned to be in active use. The effective period for a plan definition determines when the content is applicable for usage and is independent of publication and review dates. For example, a plan definition intended to be used for the year 2016 might be published in 2015.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)effectivePeriod:Period>?
[]< Descriptive topics related to the content of the plan definition. Topics provide a high-level categorization of the definition that can be useful for filtering and searching. DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'topic' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#topic and useContext.valueCodeableConcept indicating the topic) Binding: definition-topic (example, High-level categorization of the definition, used for searching, sorting, and filtering.); (xsd)topic:CodeableConcept>*
[]< An individiual or organization primarily involved in the creation and maintenance of the content.; (xsd)author:ContactDetail>*
[]< An individual or organization primarily responsible for internal coherence of the content.; (xsd)editor:ContactDetail>*
[]< An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the content. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)reviewer:ContactDetail>*
[]< An individual or organization asserted by the publisher to be responsible for officially endorsing the content for use in some setting. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)endorser:ContactDetail>*
[]< Related artifacts such as additional documentation, justification, or bibliographic references. Each related artifact is either an attachment, or a reference to another resource, but not both.; (xsd)relatedArtifact:RelatedArtifact>*
[]< A reference to a Library resource containing any formal logic used by the plan definition.; (xsd)library:Library*>*
[]< A goal describes an expected outcome that activities within the plan are intended to achieve. For example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, meeting the acceptance criteria for a test as specified by a quality specification, etc.; (xsd)goal:shareableplandefinition.goal>*
[]< Actors represent the individuals or groups involved in the execution of the defined set of activities.; (xsd)actor:shareableplandefinition.actor>*
[]< An action or group of actions to be taken as part of the plan. For example, in clinical care, an action would be to prescribe a particular indicated medication, or perform a particular test as appropriate. In pharmaceutical quality, an action would be the test that needs to be performed on a drug product as defined in the quality specification. Note that there is overlap between many of the elements defined here and the ActivityDefinition resource. When an ActivityDefinition is referenced (using the definition element), the overlapping elements in the plan override the content of the referenced ActivityDefinition unless otherwise documented in the specific elements. See the PlanDefinition resource for more detailed information.; (xsd)action:shareableplandefinition.action>*
< If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example "pain", "on flare-up", etc. Binding: medication-as-needed-reason (example, A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc.); (xsd)asNeeded:(<boolean>
|<CodeableConcept>)>?
[]< Defines a knowledge capability afforded by this knowledge artifact.; (xsd)knowledgeCapability:Extension>*
[]< Defines a knowledge representation level provided by this knowledge artifact.; (xsd)knowledgeRepresentationLevel:Extension>*
[]< A comment containing additional documentation, a review comment, usage guidance, or other relevant information from a particular user.; (xsd)artifactComment:Extension>*🔗 An action or group of actions to be taken as part of the plan. For example, in clinical care, an action would be to prescribe a particular indicated medication, or perform a particular test as appropriate. In pharmaceutical quality, an action would be the test that needs to be performed on a drug product as defined in the quality specification. Note that there is overlap between many of the elements defined here and the ActivityDefinition resource. When an ActivityDefinition is referenced (using the definition element), the overlapping elements in the plan override the content of the referenced ActivityDefinition unless otherwise documented in the specific elements. See the PlanDefinition resource for more detailed information.shareableplandefinition.action(xsd)(doc)=
<#base:PlanDefinition.action>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< An identifier that is unique within the PlanDefinition to allow linkage within the realized CarePlan and/or RequestOrchestration.; (xsd)linkId:string>?
< A user-visible prefix for the action. For example a section or item numbering such as 1. or A.; (xsd)prefix:string>?
< The textual description of the action displayed to a user. For example, when the action is a test to be performed, the title would be the title of the test such as Assay by HPLC.; (xsd)title:string>?
< A brief description of the action used to provide a summary to display to the user.; (xsd)description:markdown>?
< A text equivalent of the action to be performed. This provides a human-interpretable description of the action when the definition is consumed by a system that might not be capable of interpreting it dynamically.; (xsd)textEquivalent:markdown>?
< Indicates how quickly the action should be addressed with respect to other actions. Binding: request-priority (required, Identifies the level of importance to be assigned to actioning the request.); (xsd)priority:code>?
< A code that provides a meaning, grouping, or classification for the action or action group. For example, a section may have a LOINC code for the section of a documentation template. In pharmaceutical quality, an action (Test) such as pH could be classified as a physical property. Binding: action-code (example, Provides examples of actions to be performed.); (xsd)code:CodeableConcept>?
[]< A description of why this action is necessary or appropriate. This is different than the clinical evidence documentation, it's an actual business description of the reason for performing the action. Binding: action-reason-code (example, Provides examples of reasons for actions to be performed.); (xsd)reason:CodeableConcept>*
[]< Didactic or other informational resources associated with the action that can be provided to the CDS recipient. Information resources can include inline text commentary and links to web resources.; (xsd)documentation:RelatedArtifact>*
[]< Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition. In pharmaceutical quality, a goal represents acceptance criteria (Goal) for a given action (Test), so the goalId would be the unique id of a defined goal element establishing the acceptance criteria for the action.; (xsd)goalId:id>*
< A code, group definition, or canonical reference that describes the intended subject of the action and its children, if any. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource. The subject of an action overrides the subject at a parent action or on the root of the PlanDefinition if specified.
In addition, because the subject needs to be resolved during realization, use of subjects in actions (or in the ActivityDefinition referenced by the action) resolves based on the set of subjects supplied in context and by type (i.e. the patient subject would resolve to a resource of type Patient). Binding: participant-resource-types (extensible, The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).); (xsd)subject:(<CodeableConcept>
|<Group>
|<Resource>)>?
[]< A description of when the action should be triggered. When multiple triggers are specified on an action, any triggering event invokes the action.; (xsd)trigger:TriggerDefinition>*
[]< An expression that describes applicability criteria or start/stop conditions for the action. When multiple conditions of the same kind are present, the effects are combined using AND semantics, so the overall condition is true only if all the conditions are true.; (xsd)condition:shareableplandefinition.action.condition>*
[]< Defines input data requirements for the action.; (xsd)input:shareableplandefinition.action.input>*
[]< Defines the outputs of the action, if any.; (xsd)output:shareableplandefinition.action.output>*
[]< A relationship to another action such as "before" or "30-60 minutes after start of". When an action depends on multiple actions, the meaning is that all actions are dependencies, rather than that any of the actions are a dependency.; (xsd)relatedAction:shareableplandefinition.action.relatedAction>*
< An optional value describing when the action should be performed. The intent of the timing element is to provide timing when the action should be performed. As a definitional resource, this timing is interpreted as part of an apply operation so that the timing of the result actions in a CarePlan or RequestOrchestration, for example, would be specified by evaluating the timing definition in the context of the apply and setting the resulting timing on the appropriate elements of the target resource. If the timing is an Age, the activity is expected to be performed when the subject is the given Age. When the timing is a Duration, the activity is expected to be performed within the specified duration from the apply. When the timing is a Range, it may be a range of Ages or Durations, providing a range for the expected timing of the resulting activity. When the timing is a Timing, it is establishing a schedule for the timing of the resulting activity.; (xsd)timing:(<Age>
|<Duration>
|<Range>
|<Timing>)>?
< Identifies the facility where the action will occur; e.g. home, hospital, specific clinic, etc. May reference a specific clinical location or may just identify a type of location.; (xsd)location:Location*>?
[]< Indicates who should participate in performing the action described.; (xsd)participant:shareableplandefinition.action.participant>*
< The type of action to perform (create, update, remove). Binding: action-type (extensible, The type of action to be performed.); (xsd)type:CodeableConcept>?
< Defines the grouping behavior for the action and its children. Binding: action-grouping-behavior (required, Defines organization behavior of a group.); (xsd)groupingBehavior:code>?
< Defines the selection behavior for the action and its children. Binding: action-selection-behavior (required, Defines selection behavior of a group.); (xsd)selectionBehavior:code>?
< Defines the required behavior for the action. Binding: action-required-behavior (required, Defines expectations around whether an action or action group is required.); (xsd)requiredBehavior:code>?
< Defines whether the action should usually be preselected. Binding: action-precheck-behavior (required, Defines selection frequency behavior for an action or group.); (xsd)precheckBehavior:code>?
< Defines whether the action can be selected multiple times. Binding: action-cardinality-behavior (required, Defines behavior for an action or a group for how many times that item may be repeated.); (xsd)cardinalityBehavior:code>?
< A reference to an ActivityDefinition that describes the action to be taken in detail, a MessageDefinition describing a message to be snet, a PlanDefinition that describes a series of actions to be taken, a Questionnaire that should be filled out, a SpecimenDefinition describing a specimen to be collected, or an ObservationDefinition that specifies what observation should be captured. Note that the definition is optional, and if no definition is specified, a dynamicValue with a root ($this) path can be used to define the entire resource dynamically.; (xsd)definition:(<ActivityDefinition>
|<MessageDefinition>
|<ObservationDefinition>
|<PlanDefinition>
|<Questionnaire>
|<SpecimenDefinition>
|<uri>)>?
< A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input. Note that when a referenced ActivityDefinition also defines a transform, the transform specified here generally takes precedence. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.; (xsd)transform:StructureMap*>?
[]< Customizations that should be applied to the statically defined resource. For example, if the dosage of a medication must be computed based on the patient's weight, a customization would be used to specify an expression that calculated the weight, and the path on the resource that would contain the result. Dynamic values are applied in the order in which they are defined in the PlanDefinition resource. Note that when dynamic values are also specified by a referenced ActivityDefinition, the dynamicValues from the ActivityDefinition are applied first, followed by the dynamicValues specified here. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.; (xsd)dynamicValue:shareableplandefinition.action.dynamicValue>*
[]< Sub actions that are contained within the action. The behavior of this action determines the functionality of the sub-actions. For example, a selection behavior of at-most-one indicates that of the sub-actions, at most one may be chosen as part of realizing the action definition.; (xsd)action:PlanDefinition.action>*🔗 An expression that describes applicability criteria or start/stop conditions for the action. When multiple conditions of the same kind are present, the effects are combined using AND semantics, so the overall condition is true only if all the conditions are true.shareableplandefinition.action.condition(xsd)(doc)=
<#base:PlanDefinition.action.condition>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The kind of condition. Applicability criteria are used to determine immediate applicability when a plan definition is applied to a given context. Start and stop criteria are carried through application and used to describe enter/exit criteria for an action. Binding: action-condition-kind (required, Defines the kinds of conditions that can appear on actions.); (xsd)kind:code>
< An expression that returns true or false, indicating whether the condition is satisfied. The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.; (xsd)expression:Expression>?🔗 Customizations that should be applied to the statically defined resource. For example, if the dosage of a medication must be computed based on the patient's weight, a customization would be used to specify an expression that calculated the weight, and the path on the resource that would contain the result. Dynamic values are applied in the order in which they are defined in the PlanDefinition resource. Note that when dynamic values are also specified by a referenced ActivityDefinition, the dynamicValues from the ActivityDefinition are applied first, followed by the dynamicValues specified here. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.shareableplandefinition.action.dynamicValue(xsd)(doc)=
<#base:PlanDefinition.action.dynamicValue>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The path to the element to be customized. This is the path on the resource that will hold the result of the calculation defined by the expression. The specified path SHALL be a FHIRPath resolvable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. 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). To specify the path to the current action being realized, the %action environment variable is available in this path. For example, to specify the description element of the target action, the path would be %action.description. The path attribute contains a [Simple FHIRPath Subset](fhirpath.html#simple) that allows path traversal, but not calculation.; (xsd)path:string>?
< An expression specifying the value of the customized element. The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.; (xsd)expression:Expression>?🔗 Defines input data requirements for the action.shareableplandefinition.action.input(xsd)(doc)=
<#base:PlanDefinition.action.input>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A human-readable label for the data requirement used to label data flows in BPMN or similar diagrams. Also provides a human readable label when rendering the data requirement that conveys its purpose to human readers.; (xsd)title:string>?
< Defines the data that is to be provided as input to the action.; (xsd)requirement:DataRequirement>?
< Points to an existing input or output element that provides data to this input. The relatedData element allows indicating that an input to a parent action is an input to specific child actions. It also allows the output of one action to be identified as the input to a different action; (xsd)relatedData:id>?🔗 Defines the outputs of the action, if any.shareableplandefinition.action.output(xsd)(doc)=
<#base:PlanDefinition.action.output>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A human-readable label for the data requirement used to label data flows in BPMN or similar diagrams. Also provides a human readable label when rendering the data requirement that conveys its purpose to human readers.; (xsd)title:string>?
< Defines the data that results as output from the action.; (xsd)requirement:DataRequirement>?
< Points to an existing input or output element that is results as output from the action. The relatedData element allows indicating that the output of child action is also the output of a parent action. It also allows the input of one action to be identified as the output of a different action; (xsd)relatedData:string>?🔗 Indicates who should participate in performing the action described.shareableplandefinition.action.participant(xsd)(doc)=
<#base:PlanDefinition.action.participant>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A reference to the id element of the actor who will participate in this action.; (xsd)actorId:string>?
< The type of participant in the action. Binding: action-participant-type (required, The type of participant in the activity.); (xsd)type:code>?
< The type of participant in the action.; (xsd)typeCanonical:CapabilityStatement*>?
< The type of participant in the action. When this element is a reference, it SHOULD be a reference to a definitional resource (for example, a location type, rather than a specific location).; (xsd)typeReference:(<CareTeam>
|<Device>
|<DeviceDefinition>
|<Endpoint>
|<Group>
|<HealthcareService>
|<Location>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>?
< The role the participant should play in performing the described action. Binding: http://terminology.hl7.org/ValueSet/action-participant-role (example, Defines roles played by participants for the action.); (xsd)role:CodeableConcept>?
< Indicates how the actor will be involved in the action - author, reviewer, witness, etc. Binding: action-participant-function (example, ); (xsd)function:CodeableConcept>?🔗 A relationship to another action such as "before" or "30-60 minutes after start of". When an action depends on multiple actions, the meaning is that all actions are dependencies, rather than that any of the actions are a dependency.shareableplandefinition.action.relatedAction(xsd)(doc)=
<#base:PlanDefinition.action.relatedAction>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The element id of the target related action.; (xsd)targetId:id>
< The relationship of the start of this action to the related action. Binding: action-relationship-type (required, Defines the types of relationships between actions.); (xsd)relationship:code>
< The relationship of the end of this action to the related action. Binding: action-relationship-type (required, Defines the types of relationships between actions.); (xsd)endRelationship:code>?
< A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.; (xsd)offset:(<Duration>
|<Range>)>?🔗 Actors represent the individuals or groups involved in the execution of the defined set of activities.shareableplandefinition.actor(xsd)(doc)=
<#base:PlanDefinition.actor>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A descriptive label for the actor.; (xsd)title:string>?
< A description of how the actor fits into the overall actions of the plan definition.; (xsd)description:markdown>?
[]< The characteristics of the candidates that could serve as the actor.; (xsd)option:shareableplandefinition.actor.option>+🔗 The characteristics of the candidates that could serve as the actor.shareableplandefinition.actor.option(xsd)(doc)=
<#base:PlanDefinition.actor.option>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The type of participant in the action. Binding: action-participant-type (required, The type of participant in the activity.); (xsd)type:code>?
< The type of participant in the action.; (xsd)typeCanonical:CapabilityStatement*>?
< The type of participant in the action. When this element is a reference, it SHOULD be a reference to a definitional resource (for example, a location type, rather than a specific location).; (xsd)typeReference:(<CareTeam>
|<Device>
|<DeviceDefinition>
|<Endpoint>
|<Group>
|<HealthcareService>
|<Location>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>?
< The role the participant should play in performing the described action. Binding: http://terminology.hl7.org/ValueSet/action-participant-role (example, ); (xsd)role:CodeableConcept>?🔗 A goal describes an expected outcome that activities within the plan are intended to achieve. For example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, meeting the acceptance criteria for a test as specified by a quality specification, etc.shareableplandefinition.goal(xsd)(doc)=
<#base:PlanDefinition.goal>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Indicates a category the goal falls within. Binding: goal-category (example, Example codes for grouping goals for filtering or presentation.); (xsd)category:CodeableConcept>?
< Human-readable and/or coded description of a specific desired objective of care, such as "control blood pressure" or "negotiate an obstacle course" or "dance with child at wedding". If no code is available, use CodeableConcept.text. Binding: clinical-findings (example, Describes goals that can be achieved.); (xsd)description:CodeableConcept>
< Identifies the expected level of importance associated with reaching/sustaining the defined goal. Binding: goal-priority (preferred, Indicates the level of importance associated with reaching or sustaining a goal.); (xsd)priority:CodeableConcept>?
< The event after which the goal should begin being pursued. Binding: goal-start-event (example, Identifies the types of events that might trigger the start of a goal.); (xsd)start:CodeableConcept>?
[]< Identifies problems, conditions, issues, or concerns the goal is intended to address. Binding: condition-code (example, Identifies problems, conditions, issues, or concerns that goals may address.); (xsd)addresses:CodeableConcept>*
[]< Didactic or other informational resources associated with the goal that provide further supporting information about the goal. Information resources can include inline text commentary and links to web resources.; (xsd)documentation:RelatedArtifact>*
[]< Indicates what should be done and within what timeframe.; (xsd)target:shareableplandefinition.goal.target>*🔗 Indicates what should be done and within what timeframe.shareableplandefinition.goal.target(xsd)(doc)=
<#base:PlanDefinition.goal.target>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The parameter whose value is to be tracked, e.g. body weight, blood pressure, or hemoglobin A1c level. Binding: observation-codes (example, Identifies types of parameters that can be tracked to determine goal achievement.); (xsd)measure:CodeableConcept>?
< The target value of the measure to be achieved to signify fulfillment of the goal, e.g. 150 pounds or 7.0%, or in the case of pharmaceutical quality - NMT 0.6%, Clear solution, etc. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any value at or above the low value. A CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the goal.target.measure defines a coded value.; (xsd)detail:(<boolean>
|<CodeableConcept>
|<integer>
|<Quantity>
|<Range>
|<Ratio>
|<string>)>?
< Indicates the timeframe after the start of the goal in which the goal should be met.; (xsd)due:Duration>?🔗 A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.shareabletestscript(xsd)(doc)=
<#base:TestScript>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< An absolute URI that is used to identify this test script when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this test script is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the test script is stored on different servers. Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.
The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions).
In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.; (xsd)url:uri>
[]< A formal identifier that is used to identify this test script when it is represented in other formats, or referenced in a specification, model, design or an instance. Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this test script outside of FHIR, where it is not possible to use the logical URI.; (xsd)identifier:Identifier>*
< The identifier that is used to identify this version of the test script when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the test script author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. There may be different test script instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the test script with the format [url]|[version]. The version SHOULD NOT contain a '#' - see [Business Version](resource.html#bv-format).; (xsd)version:string>
< Indicates the mechanism used to compare versions to determine which is more current. If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined. Binding: version-algorithm (extensible, ); (xsd)versionAlgorithm:(<Coding>
|<string>)>?
< A natural language name identifying the test script. This name should be usable as an identifier for the module by machine processing applications such as code generation. The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.; (xsd)name:string>
< A short, descriptive, user-friendly title for the test script. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.; (xsd)title:string>?
< The status of this test script. Enables tracking the life-cycle of the content. Allows filtering of test scripts that are appropriate for use versus not.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization). Binding: publication-status (required, The lifecycle status of an artifact.); (xsd)status:code>
< A Boolean value to indicate that this test script is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. Allows filtering of test scripts that are appropriate for use versus not.; (xsd)experimental:boolean>
< The date (and optionally time) when the test script was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the test script changes. The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the test script. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)date:dateTime>?
< The name of the organization or individual responsible for the release and ongoing maintenance of the test script. Usually an organization but may be an individual. The publisher (or steward) of the test script is the organization or individual primarily responsible for the maintenance and upkeep of the test script. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the test script. This item SHOULD be populated unless the information is available from context.; (xsd)publisher:string>
[]< Contact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)contact:ContactDetail>*
< A free text natural language description of the test script from a consumer's perspective. This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the test script as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the test script is presumed to be the predominant language in the place the test script was created).; (xsd)description:markdown>
[]< The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate test script instances. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.; (xsd)useContext:UsageContext>*
[]< A legal or geographic region in which the test script is intended to be used. It may be possible for the test script to be used in jurisdictions other than those for which it was originally designed or intended.
DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.) Binding: jurisdiction (extensible, Countries and regions within which this artifact is targeted for use.); (xsd)jurisdiction:CodeableConcept>*
< Explanation of why this test script is needed and why it has been designed as it has. This element does not describe the usage of the test script. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this test script.; (xsd)purpose:markdown>?
< A copyright statement relating to the test script and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the test script.; (xsd)copyright:markdown>?
< A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved'). The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.; (xsd)copyrightLabel:string>?
[]< An abstract server used in operations within this test script in the origin element. The purpose of this element is to define the profile of an origin element used elsewhere in the script. Test engines could then use the origin-profile mapping to offer a filtered list of test systems that can serve as the sender for the interaction.; (xsd)origin:shareabletestscript.origin>*
[]< An abstract server used in operations within this test script in the destination element. The purpose of this element is to define the profile of a destination element used elsewhere in the script. Test engines could then use the destination-profile mapping to offer a filtered list of test systems that can serve as the receiver for the interaction.; (xsd)destination:shareabletestscript.destination>*
< The required capability must exist and are assumed to function correctly on the FHIR server being tested.; (xsd)metadata:shareabletestscript.metadata>?
[]< The scope indicates a conformance artifact that is tested by the test(s) within this test case and the expectation of the test outcome(s) as well as the intended test phase inclusion.; (xsd)scope:shareabletestscript.scope>*
[]< Fixture in the test script - by reference (uri). All fixtures are required for the test script to execute.; (xsd)fixture:shareabletestscript.fixture>*
[]< Reference to the profile to be used for validation. See the [Resource List](resourcelist.html) for complete list of resource types.; (xsd)profile:StructureDefinition*>*
[]< Variable is set based either on element value in response body or on header field value in the response headers. Variables would be set based either on XPath/JSONPath expressions against fixtures (static and response), or headerField evaluations against response headers. If variable evaluates to nodelist or anything other than a primitive value, then test engine would report an error. Variables would be used to perform clean replacements in "operation.params", "operation.requestHeader.value", and "operation.url" element values during operation calls and in "assert.value" during assertion evaluations. This limits the places that test engines would need to look for placeholders "${}". Variables are scoped to the whole script. They are NOT evaluated at declaration. They are evaluated by test engine when used for substitutions in "operation.params", "operation.requestHeader.value", and "operation.url" element values during operation calls and in "assert.value" during assertion evaluations. See example testscript-search.xml.; (xsd)variable:shareabletestscript.variable>*
< A series of required setup operations before tests are executed.; (xsd)setup:shareabletestscript.setup>?
[]< A test in this script.; (xsd)test:shareabletestscript.test>*
< A series of operations required to clean up after all the tests are executed (successfully or otherwise).; (xsd)teardown:shareabletestscript.teardown>?🔗 An abstract server used in operations within this test script in the destination element. The purpose of this element is to define the profile of a destination element used elsewhere in the script. Test engines could then use the destination-profile mapping to offer a filtered list of test systems that can serve as the receiver for the interaction.shareabletestscript.destination(xsd)(doc)=
<#base:TestScript.destination>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Abstract name given to a destination server in this test script. The name is provided as a number starting at 1. A given destination index (e.g. 1) can appear only once in the list (e.g. Destination 1 cannot be specified twice ... once as Form-Manager and again as Form-Processor within the same script as that could get confusing during test configuration).
Different destination indices could play the same actor in the same test script (e.g. You could have two different test systems acting as Form-Manager).
The destination indices provided elsewhere in the test script must be one of these destination indices.; (xsd)index:integer>
< The type of destination profile the test system supports. Must be a "receiver"/"server" profile. Binding: testscript-profile-destination-types (extensible, The type of destination profile the test system supports.); (xsd)profile:Coding>
< The explicit url path of the destination server used in this test script. If provided, the test engine is not expected to prompt for or accept external input of this value.; (xsd)url>?🔗 Fixture in the test script - by reference (uri). All fixtures are required for the test script to execute.shareabletestscript.fixture(xsd)(doc)=
<#base:TestScript.fixture>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Whether or not to implicitly create the fixture during setup. If true, the fixture is automatically created on each server being tested during setup, therefore no create operation is required for this fixture in the TestScript.setup section.; (xsd)autocreate:boolean>
< Whether or not to implicitly delete the fixture during teardown. If true, the fixture is automatically deleted on each server being tested during teardown, therefore no delete operation is required for this fixture in the TestScript.teardown section.; (xsd)autodelete:boolean>
< Reference to the resource (containing the contents of the resource needed for operations). This is allowed to be a Parameters resource. See the [Resource List](resourcelist.html) for complete list of resource types.; (xsd)resource:Resource*>?🔗 The required capability must exist and are assumed to function correctly on the FHIR server being tested.shareabletestscript.metadata(xsd)(doc)=
<#base:TestScript.metadata>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< A link to the FHIR specification that this test is covering.; (xsd)link:shareabletestscript.metadata.link>*
[]< Capabilities that must exist and are assumed to function correctly on the FHIR server being tested. When the metadata capabilities section is defined at TestScript.metadata or at TestScript.setup.metadata, and the server's conformance statement does not contain the elements defined in the minimal conformance statement, then all the tests in the TestScript are skipped. When the metadata capabilities section is defined at TestScript.test.metadata and the server's conformance statement does not contain the elements defined in the minimal conformance statement, then only that test is skipped. The "metadata.capabilities.required" and "metadata.capabilities.validated" elements only indicate whether the capabilities are the primary focus of the test script or not. They do not impact the skipping logic. Capabilities whose "metadata.capabilities.validated" flag is true are the primary focus of the test script.; (xsd)capability:shareabletestscript.metadata.capability>+🔗 Capabilities that must exist and are assumed to function correctly on the FHIR server being tested. When the metadata capabilities section is defined at TestScript.metadata or at TestScript.setup.metadata, and the server's conformance statement does not contain the elements defined in the minimal conformance statement, then all the tests in the TestScript are skipped. When the metadata capabilities section is defined at TestScript.test.metadata and the server's conformance statement does not contain the elements defined in the minimal conformance statement, then only that test is skipped. The "metadata.capabilities.required" and "metadata.capabilities.validated" elements only indicate whether the capabilities are the primary focus of the test script or not. They do not impact the skipping logic. Capabilities whose "metadata.capabilities.validated" flag is true are the primary focus of the test script.shareabletestscript.metadata.capability(xsd)(doc)=
<#base:TestScript.metadata.capability>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Whether or not the test execution will require the given capabilities of the server in order for this test script to execute.; (xsd)required:boolean>
< Whether or not the test execution will validate the given capabilities of the server in order for this test script to execute.; (xsd)validated:boolean>
< Description of the capabilities that this test script is requiring the server to support.; (xsd)description:string>?
[]< Which origin server these requirements apply to.; (xsd)origin:integer>*
< Which server these requirements apply to.; (xsd)destination:integer>?
[]< Links to the FHIR specification that describes this interaction and the resources involved in more detail.; (xsd)link:uri>*
< Minimum capabilities required of server for test script to execute successfully. If server does not meet at a minimum the referenced capability statement, then all tests in this script are skipped. The conformance statement of the server has to contain at a minimum the contents of the reference pointed to by this element.; (xsd)capabilities:CapabilityStatement*>🔗 A link to the FHIR specification that this test is covering.shareabletestscript.metadata.link(xsd)(doc)=
<#base:TestScript.metadata.link>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< URL to a particular requirement or feature within the FHIR specification.; (xsd)url:uri>
< Short description of the link.; (xsd)description:string>?🔗 An abstract server used in operations within this test script in the origin element. The purpose of this element is to define the profile of an origin element used elsewhere in the script. Test engines could then use the origin-profile mapping to offer a filtered list of test systems that can serve as the sender for the interaction.shareabletestscript.origin(xsd)(doc)=
<#base:TestScript.origin>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Abstract name given to an origin server in this test script. The name is provided as a number starting at 1. A given origin index (e.g. 1) can appear only once in the list (e.g. Origin 1 cannot be specified twice ... once as FormFiller and again as FormProcessor within the same script as that could get confusing during test configuration).
Different origin indices could play the same actor in the same test script (e.g. You could have two different test systems acting as Form-Filler).
The origin indices provided elsewhere in the test script must be one of these origin indices.; (xsd)index:integer>
< The type of origin profile the test system supports. Must be a "sender"/"client" profile. Binding: testscript-profile-origin-types (extensible, The type of origin profile the test system supports.); (xsd)profile:Coding>
< The explicit url path of the origin server used in this test script. If provided, the test engine is not expected to prompt for or accept external input of this value.; (xsd)url>?🔗 The scope indicates a conformance artifact that is tested by the test(s) within this test case and the expectation of the test outcome(s) as well as the intended test phase inclusion.shareabletestscript.scope(xsd)(doc)=
<#base:TestScript.scope>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The specific conformance artifact being tested. The canonical reference can be version-specific.; (xsd)artifact:Resource*>
< The expectation of whether the test must pass for the system to be considered conformant with the artifact: required - all tests are expected to pass, optional - all test are expected to pass but non-pass status may be allowed, strict - all tests are expected to pass and warnings are treated as a failure. Binding: testscript-scope-conformance-codes (extensible, The expectation of whether the test must pass for the system to be considered conformant with the artifact.); (xsd)conformance:CodeableConcept>?
< The phase of testing for this artifact: unit - development / implementation phase, integration - internal system to system phase, production - live system to system phase (Note, this may involve pii/phi data). Binding: testscript-scope-phase-codes (extensible, The phase of testing for this artifact.); (xsd)phase:CodeableConcept>?🔗 A series of required setup operations before tests are executed.shareabletestscript.setup(xsd)(doc)=
<#base:TestScript.setup>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< Action would contain either an operation or an assertion. An action should contain either an operation or an assertion but not both. It can contain any number of variables.; (xsd)action:shareabletestscript.setup.action>+🔗 Action would contain either an operation or an assertion. An action should contain either an operation or an assertion but not both. It can contain any number of variables.shareabletestscript.setup.action(xsd)(doc)=
<#base:TestScript.setup.action>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The operation to perform.; (xsd)operation:shareabletestscript.setup.action.operation>?
< Evaluates the results of previous operations to determine if the server under test behaves appropriately. In order to evaluate an assertion, the request, response, and results of the most recently executed operation must always be maintained by the test engine.; (xsd)assert:shareabletestscript.setup.action.assert>?🔗 Evaluates the results of previous operations to determine if the server under test behaves appropriately. In order to evaluate an assertion, the request, response, and results of the most recently executed operation must always be maintained by the test engine.shareabletestscript.setup.action.assert(xsd)(doc)=
<#base:TestScript.setup.action.assert>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The label would be used for tracking/logging purposes by test engines. This has no impact on the verification itself.; (xsd)label:string>?
< The description would be used by test engines for tracking and reporting purposes. This has no impact on the verification itself.; (xsd)description:string>?
< The direction to use for the assertion. If the direction is specified as "response" (the default), then the processing of this assert is against the received response message. If the direction is specified as "request", then the processing of this assert is against the sent request message. Binding: assert-direction-codes (required, The direction to use for assertions.); (xsd)direction:code>?
< Id of the source fixture used as the contents to be evaluated by either the "source/expression" or "sourceId/path" definition.; (xsd)compareToSourceId:string>?
< The FHIRPath expression for a specific value to evaluate against the source fixture. When compareToSourceId is defined, either compareToSourceExpression or compareToSourcePath must be defined, but not both. Thefhirpath expression to be evaluated against the expected fixture to compare to. Ignored if "assert.value" is used. The evaluation will be done before the assertion is evaluated.; (xsd)compareToSourceExpression:string>?
< XPath or JSONPath expression to evaluate against the source fixture. When compareToSourceId is defined, either compareToSourceExpression or compareToSourcePath must be defined, but not both. The XPath or JSONPath expression to be evaluated against the expected fixture to compare to. Ignored if "assert.value" is used. The evaluation will be done before the assertion is evaluated.; (xsd)compareToSourcePath:string>?
< The mime-type contents to compare against the request or response message 'Content-Type' header. If this is specified, then test engine shall confirm that the content-type of the last operation's headers is set to this value. If "assert.sourceId" element is specified, then the evaluation will be done against the headers mapped to that sourceId (and not the last operation's headers). If you'd like to have more control over the string, then use 'assert.headerField' instead. Binding: mimetypes (required, BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)); (xsd)contentType:code>?
< The default manual completion outcome applied to this assertion. Manual completion is used to pause the test engine execution and evaluation allowing an external review of the defined assert condition. The defaultManualCompletion defines the default manual completion outcome applied if one of the enumerated values is not applied. Binding: assert-manual-completion-codes (required, The default type of manual completion to use for assertion.); (xsd)defaultManualCompletion:code>?
< The FHIRPath expression to be evaluated against the request or response message contents - HTTP headers and payload. If both "expression" and a "fixtureId" are specified, then the expression will be evaluated against the request or response body mapped to the fixtureId. If "expression" is specified and a "fixtureId" is not, then the expression will be evaluated against the response body of the last operation. Test engines are to store the request and response body and headers of the last operation at all times for subsequent assertions.
The FHIRPath expression can be evaluated as either a path to a specific value or as a boolean expression against the given FHIR resource. When the FHIRPath is a boolean expression, the assert.value element is not used. See [Testing FHIR Use Expressions](testing.html#expressions).; (xsd)expression:string>?
< The HTTP header field name e.g. 'Location'. If "headerField" is specified then "value" must be specified. If "sourceId" is not specified, then "headerField" will be evaluated against the last operation's response headers. Test engines are to keep track of the last operation's response body and response headers.; (xsd)headerField:string>?
< The ID of a fixture. Asserts that the response contains at a minimum the fixture specified by minimumId. Asserts that the response contains all the element/content in another fixture pointed to by minimumId. This can be a statically defined fixture or one that is dynamically set via responseId.
See [Testing FHIR Use minimumId](testing.html##minimumId) for a more complete description of the test engine's comparison logic.; (xsd)minimumId:string>?
< Whether or not the test execution performs validation on the bundle navigation links. Asserts that the Bundle contains first, last, and next links.; (xsd)navigationLinks:boolean>?
< The operator type defines the conditional behavior of the assert. Operators are useful for both positive and negative testing. If operator is not specified, then the default conditional behavior is implemented as defined in [Testing FHIR Assertions](testing.html#assertion-table). Binding: assert-operator-codes (required, The type of operator to use for assertions.); (xsd)operator:code>?
< The XPath or JSONPath expression to be evaluated against the fixture representing the response received from server. If both "path" and a "fixtureId" are specified, then the path will be evaluated against the request or response body mapped to the fixtureId. If "path" is specified and a "fixtureId" is not, then the path will be evaluated against the response body of the last operation. Test engines are to store the request and response body and headers of the last operation at all times for subsequent assertions.; (xsd)path:string>?
< The request method or HTTP operation code to compare against that used by the client system under test. If "requestMethod" is specified then it will be used in place of "value". The "requestMethod" will evaluate against the last operation's request HTTP operation. Binding: http-operations (required, The allowable request method or HTTP operation codes.); (xsd)requestMethod:code>?
< The value to use in a comparison against the request URL path string. If "requestURL" is specified then it will be used in place of "value". The "requestURL" will evaluate against the last operation's full request URL path string.; (xsd)requestURL:string>?
< The type of the resource. See the [resource list](resourcelist.html). This will be expected resource type in response body e.g. in read, vread, search, etc. See the [Resource List](resourcelist.html) for complete list of resource types; e.g. . Binding: concrete-fhir-types (extensible, A list of all the concrete types defined in this version of the FHIR specification - Data Types and Resource Types.); (xsd)resource:uri>?
< continue | switchingProtocols | okay | created | accepted | nonAuthoritativeInformation | noContent | resetContent | partialContent | multipleChoices | movedPermanently | found | seeOther | notModified | useProxy | temporaryRedirect | permanentRedirect | badRequest | unauthorized | paymentRequired | forbidden | notFound | methodNotAllowed | notAcceptable | proxyAuthenticationRequired | requestTimeout | conflict | gone | lengthRequired | preconditionFailed | contentTooLarge | uriTooLong | unsupportedMediaType | rangeNotSatisfiable | expectationFailed | misdirectedRequest | unprocessableContent | upgradeRequired | internalServerError | notImplemented | badGateway | serviceUnavailable | gatewayTimeout | httpVersionNotSupported. This is a shorter way of achieving similar verifications via "assert.responseCode". If you need more control, then use "assert.responseCode" e.g. . Binding: assert-response-code-types (required, The response code to expect in the response.); (xsd)response:code>?
< The value of the HTTP response code to be tested. To be used with "operator" attribute value. Asserts that the response code equals this value if "operator" is not specified. If the operator is "in" or "notIn" then the responseCode would be a comma-separated list of values e.g. "200,201". Otherwise, it's expected to be a numeric value. If "fixture" is not specified, then the "responseBodyId" value of the last operation is assumed.; (xsd)responseCode:string>?
< Fixture to evaluate the XPath/JSONPath expression or the headerField against. This can be a statically defined fixture (at the top of the testscript) or a dynamically set fixture created by responseId of the action.operation element.; (xsd)sourceId:id>?
< Whether or not the current test execution will stop on failure for this assert. If this element is specified and it is true, then assertion failures should not stop the current test execution from proceeding.; (xsd)stopTestOnFail:boolean>
< The ID of the Profile to validate against. The ID of a Profile fixture. Asserts that the response is valid according to the Profile specified by validateProfileId.; (xsd)validateProfileId:id>?
< The value to compare to. The string-representation of a number, string, or boolean that is expected. Test engines do have to look for placeholders (${}) and replace the variable placeholders with the variable values at runtime before comparing this value to the actual value.; (xsd)value:string>?
< Whether or not the test execution will produce a warning only on error for this assert. If this element is specified and it is true, then assertion failures can be logged by test engine but should not stop the test script execution from proceeding. There are likely cases where the spec is not clear on what should happen. If the spec says something is optional (maybe a response header for example), but a server doesn’t do it, we could choose to issue a warning.; (xsd)warningOnly:boolean>
[]< Links or references providing traceability to the testing requirements for this assert. TestScript and TestReport instances are typically (and expected to be) based on known, defined test requirements and documentation. These links provide traceability from the executable/executed TestScript and TestReport tests to these requirements.; (xsd)requirement:shareabletestscript.setup.action.assert.requirement>*🔗 Links or references providing traceability to the testing requirements for this assert. TestScript and TestReport instances are typically (and expected to be) based on known, defined test requirements and documentation. These links provide traceability from the executable/executed TestScript and TestReport tests to these requirements.shareabletestscript.setup.action.assert.requirement(xsd)(doc)=
<#base:TestScript.setup.action.assert.requirement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Link or reference providing traceability to the testing requirement for this test.; (xsd)link:(<Requirements>
|<uri>)>?🔗 The operation to perform.shareabletestscript.setup.action.operation(xsd)(doc)=
<#base:TestScript.setup.action.operation>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Server interaction or operation type. See the list of [server interactions](http.html). Binding: testscript-operation-codes (extensible, FHIR Operation Code Types); (xsd)type:Coding>?
< The type of the FHIR resource. See the [resource list](resourcelist.html). Data type of uri is needed when non-HL7 artifacts are identified. If "url" element is specified, then "targetId", "params", and "resource" elements will be ignored as "url" element will have everything needed for constructing the request url. If "params" element is specified, then "targetId" element is ignored. For FHIR operations that require a resource (e.g. "read" and "vread" operations), the "resource" element must be specified when "params" element is specified. If "url" and "params" elements are absent, then the request url will be constructed from "targetId" fixture if present. For "read" operation, the resource and id values will be extracted from "targetId" fixture and used to construct the url. For "vread" and "history" operations, the versionId value will also be used. Binding: concrete-fhir-types (extensible, A list of all the concrete types defined in this version of the FHIR specification - Data Types and Resource Types.); (xsd)resource:uri>?
< The label would be used for tracking/logging purposes by test engines. This has no impact on the verification itself.; (xsd)label:string>?
< The description would be used by test engines for tracking and reporting purposes. This has no impact on the verification itself.; (xsd)description:string>?
< The mime-type to use for RESTful operation in the 'Accept' header. If this is specified, then test engine shall set the 'Accept' header to the corresponding value. If you'd like to explicitly set the 'Accept' to some other value then use the 'requestHeader' element. Binding: mimetypes (required, BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)); (xsd)accept:code>?
< The mime-type to use for RESTful operation in the 'Content-Type' header. If this is specified, then test engine shall set the 'Content-Type' header to the corresponding value. If you'd like to explicitly set the 'Content-Type' to some other value then use the 'requestHeader' element. Binding: mimetypes (required, BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)); (xsd)contentType:code>?
< The server where the request message is destined for. Must be one of the server numbers listed in TestScript.destination section. If multiple TestScript.destination elements are defined and operation.destination is undefined, test engine will report an error as it cannot determine what destination to use for the exchange.; (xsd)destination:integer>?
< Whether or not to implicitly send the request url in encoded format. The default is true to match the standard RESTful client behavior. Set to false when communicating with a server that does not support encoded url paths.; (xsd)encodeRequestUrl:boolean>
< The HTTP method the test engine MUST use for this operation regardless of any other operation details. The primary purpose of the explicit HTTP method is support of HTTP POST method invocation of the FHIR search. Other uses will include support of negative testing. Binding: http-operations (required, The allowable request method or HTTP operation codes.); (xsd)method:code>?
< The server where the request message originates from. Must be one of the server numbers listed in TestScript.origin section. If absent, test engine will send the message. When present, test engine will not send the request message but will wait for the request message to be sent from this origin server.; (xsd)origin:integer>?
< Path plus parameters after [type]. Used to set parts of the request URL explicitly. If "url" element is specified, then "targetId", "params", and "resource" elements will be ignored as "url" element will have everything needed for constructing the request url. If "params" element is specified, then "targetId" element is ignored. For FHIR operations that require a resource (e.g. "read" and "vread" operations), the "resource" element must be specified when "params" element is specified. If "url" and "params" elements are absent, then the request url will be constructed from "targetId" fixture if present. For "read" operation, the resource and id values will be extracted from "targetId" fixture and used to construct the url. For "vread" and "history" operations, the versionId value will also be used. Test engines would append whatever is specified for "params" to the URL after the resource type without tampering with the string (beyond encoding the URL for HTTP). The "params" element does not correspond exactly to "search parameters". Nor is it the "path". It corresponds to the part of the URL that comes after the [type] (when "resource" element is specified); e.g. It corresponds to "/[id]/_history/[vid] {?_format=[mime-type]}" in the following operation: GET [base]/[type]/[id]/_history/[vid] {?_format=[mime-type]} Test engines do have to look for placeholders (${}) and replace the variable placeholders with the variable values at runtime before sending the request.; (xsd)params:string>?
[]< Header elements would be used to set HTTP headers. This gives control to test-script writers to set headers explicitly based on test requirements. It will allow for testing using: - "If-Modified-Since" and "If-None-Match" headers. ["If-Match" header](http.html#2.1.0.5.1). See [Conditional Create using "If-None-Exist"](http.html#2.1.0.11). See [Invalid "Content-Type" header](http.html#2.1.0.13.1) for negative testing. - etc.; (xsd)requestHeader:shareabletestscript.setup.action.operation.requestHeader>*
< The fixture id (maybe new) to map to the request. If a requestId is supplied, then the resulting request (both headers and body) is mapped to the fixture ID (which may be entirely new and previously undeclared) designated by "requestId". If requestId is not specified, it is the test engine's responsibility to store the request and use it as the requestId in subsequent assertions when assertion path and/or headerField is specified, direction is equal to request, and the requestId in not specified.; (xsd)requestId:id>?
< The fixture id (maybe new) to map to the response. If a responseId is supplied, and the server responds, then the resulting response (both headers and body) is mapped to the fixture ID (which may be entirely new and previously undeclared) designated by "responseId". If responseId is not specified, it is the test engine's responsibility to store the response and use it as the responseId in subsequent assertions when assertion path and/or headerField is specified and the responseId is not specified.; (xsd)responseId:id>?
< The id of the fixture used as the body of a PUT or POST request.; (xsd)sourceId:id>?
< Id of fixture used for extracting the [id], [type], and [vid] for GET requests. If "url" element is specified, then "targetId", "params", and "resource" elements will be ignored as "url" element will have everything needed for constructing the request url. If "params" element is specified, then "targetId" element is ignored. For FHIR operations that require a resource (e.g. "read" and "vread" operations), the "resource" element must be specified when "params" element is specified. If "url" and "params" elements are absent, then the request url will be constructed from "targetId" fixture if present. For "read" operation, the resource and id values will be extracted from "targetId" fixture and used to construct the url. For "vread" and "history" operations, the versionId value will also be used.; (xsd)targetId:id>?
< Complete request URL. Used to set the request URL explicitly. If "url" element is defined, then "targetId", "resource", and "params" elements will be ignored. Test engines would use whatever is specified in "url" without tampering with the string (beyond encoding the URL for HTTP). Test engines do have to look for placeholders (${}) and replace the variable placeholders with the variable values at runtime before sending the request.; (xsd)url:string>?🔗 Header elements would be used to set HTTP headers. This gives control to test-script writers to set headers explicitly based on test requirements. It will allow for testing using: - "If-Modified-Since" and "If-None-Match" headers. ["If-Match" header](http.html#2.1.0.5.1). See [Conditional Create using "If-None-Exist"](http.html#2.1.0.11). See [Invalid "Content-Type" header](http.html#2.1.0.13.1) for negative testing. - etc.shareabletestscript.setup.action.operation.requestHeader(xsd)(doc)=
<#base:TestScript.setup.action.operation.requestHeader>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The HTTP header field e.g. "Accept". If header element is specified, then field is required.; (xsd)field:string>
< The value of the header e.g. "application/fhir+xml". If header element is specified, then value is required. No conversions will be done by the test engine e.g. "xml" to "application/fhir+xml". The values will be set in HTTP headers "as-is". Test engines do have to look for placeholders (${}) and replace the variable placeholders with the variable values at runtime before sending the request.; (xsd)value:string>🔗 A series of operations required to clean up after all the tests are executed (successfully or otherwise).shareabletestscript.teardown(xsd)(doc)=
<#base:TestScript.teardown>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< The teardown action will only contain an operation. An action should contain either an operation or an assertion but not both. It can contain any number of variables.; (xsd)action:shareabletestscript.teardown.action>+🔗 The teardown action will only contain an operation. An action should contain either an operation or an assertion but not both. It can contain any number of variables.shareabletestscript.teardown.action(xsd)(doc)=
<#base:TestScript.teardown.action>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< An operation would involve a REST request to a server.; (xsd)operation:TestScript.setup.action.operation>🔗 A test in this script.shareabletestscript.test(xsd)(doc)=
<#base:TestScript.test>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The name of this test used for tracking/logging purposes by test engines.; (xsd)name:string>?
< A short description of the test used by test engines for tracking and reporting purposes.; (xsd)description:string>?
[]< Action would contain either an operation or an assertion. An action should contain either an operation or an assertion but not both. It can contain any number of variables.; (xsd)action:shareabletestscript.test.action>+🔗 Action would contain either an operation or an assertion. An action should contain either an operation or an assertion but not both. It can contain any number of variables.shareabletestscript.test.action(xsd)(doc)=
<#base:TestScript.test.action>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< An operation would involve a REST request to a server.; (xsd)operation:TestScript.setup.action.operation>?
< Evaluates the results of previous operations to determine if the server under test behaves appropriately. In order to evaluate an assertion, the request, response, and results of the most recently executed operation must always be maintained by the test engine.; (xsd)assert:TestScript.setup.action.assert>?🔗 Variable is set based either on element value in response body or on header field value in the response headers. Variables would be set based either on XPath/JSONPath expressions against fixtures (static and response), or headerField evaluations against response headers. If variable evaluates to nodelist or anything other than a primitive value, then test engine would report an error. Variables would be used to perform clean replacements in "operation.params", "operation.requestHeader.value", and "operation.url" element values during operation calls and in "assert.value" during assertion evaluations. This limits the places that test engines would need to look for placeholders "${}". Variables are scoped to the whole script. They are NOT evaluated at declaration. They are evaluated by test engine when used for substitutions in "operation.params", "operation.requestHeader.value", and "operation.url" element values during operation calls and in "assert.value" during assertion evaluations. See example testscript-search.xml.shareabletestscript.variable(xsd)(doc)=
<#base:TestScript.variable>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Descriptive name for this variable. Placeholders would contain the variable name wrapped in ${} in "operation.params", "operation.requestHeader.value", and "operation.url" elements. These placeholders would need to be replaced by the variable value before the operation is executed.; (xsd)name:string>
< A default, hard-coded, or user-defined value for this variable. The purpose of this element is to allow for a pre-defined value that can be used as a default or as an override value. Test engines can optionally use this as a placeholder for user-defined execution time values.; (xsd)defaultValue:string>?
< A free text natural language description of the variable and its purpose.; (xsd)description:string>?
< The FHIRPath expression for a specific value to evaluate against the fixture body. When variables are defined, only one of either expression, headerField or path must be specified. If headerField is defined, then the variable will be evaluated against the headers that sourceId is pointing to. If expression or path is defined, then the variable will be evaluated against the fixture body that sourceId is pointing to. It is an error to define any combination of expression, headerField and path.; (xsd)expression:string>?
< Will be used to grab the HTTP header field value from the headers that sourceId is pointing to. If headerField is defined, then the variable will be evaluated against the headers that sourceId is pointing to. If path is defined, then the variable will be evaluated against the fixture body that sourceId is pointing to. It is an error to define both headerField and path.; (xsd)headerField:string>?
< Displayable text string with hint help information to the user when entering a default value.; (xsd)hint:string>?
< XPath or JSONPath to evaluate against the fixture body. When variables are defined, only one of either expression, headerField or path must be specified. If headerField is defined, then the variable will be evaluated against the headers that sourceId is pointing to. If expression or path is defined, then the variable will be evaluated against the fixture body that sourceId is pointing to. It is an error to define any combination of expression, headerField and path.; (xsd)path:string>?
< Fixture to evaluate the XPath/JSONPath expression or the headerField against within this variable. This can be a statically defined fixture (at the top of the TestScript) or a dynamically set fixture created by responseId of the `action.operation` element.; (xsd)sourceId:id>?🔗 A ValueSet resource instance specifies a set of codes drawn from one or more code systems, intended for use in a particular context. Value sets link between [CodeSystem](codesystem.html) definitions and their use in [coded elements](terminologies.html).shareablevalueset(xsd)(doc)=
<#base:ValueSet>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< An Extension; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< An absolute URI that is used to identify this value set when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this value set is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the value set is stored on different servers. Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.
The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions).
In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.; (xsd)url:uri>
[]< A formal identifier that is used to identify this value set when it is represented in other formats, or referenced in a specification, model, design or an instance. Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this value set outside of FHIR, where it is not possible to use the logical URI.; (xsd)identifier:Identifier>*
< The identifier that is used to identify this version of the value set when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the value set author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. There may be different value set instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the value set with the format [url]|[version]. The version SHOULD NOT contain a '#' - see [Business Version](resource.html#bv-format).; (xsd)version:string>
< Indicates the mechanism used to compare versions to determine which ValueSet is more current. If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined. Binding: version-algorithm (extensible, ); (xsd)versionAlgorithm:(<Coding>
|<string>)>?
< A natural language name identifying the value set. This name should be usable as an identifier for the module by machine processing applications such as code generation. The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.A name should be provided unless the value set is a contained resource (e.g. an anonymous value set in a profile). Most registries will require a name.; (xsd)name:string>?
< A short, descriptive, user-friendly title for the value set. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.; (xsd)title:string>
< The status of this value set. Enables tracking the life-cycle of the content. The status of the value set applies to the value set definition (ValueSet.compose) and the associated ValueSet metadata. Expansions do not have a state. Allows filtering of value sets that are appropriate for use versus not.See also the [http://hl7.org/fhir/StructureDefinition/valueset-workflowStatusDescription](http://hl7.org/fhir/extensions/StructureDefinition-valueset-workflowStatusDescription.html) extension for additional status information related to the editorial process.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization). Binding: publication-status (required, The lifecycle status of an artifact.); (xsd)status:code>
< A Boolean value to indicate that this value set is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. Allows filtering of value sets that are appropriate for use versus not.; (xsd)experimental:boolean>
< The date (and optionally time) when the value set metadata or content logical definition (.compose) was created or revised. Note that this is not the same as the meta.lastUpdated which is specific to an instance of a value set resource on a server. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)date:dateTime>?
< The name of the organization or individual responsible for the release and ongoing maintenance of the value set. Usually an organization but may be an individual. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the value set. This item SHOULD be populated unless the information is available from context.; (xsd)publisher:string>?
[]< Contact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)contact:ContactDetail>*
< A free text natural language description of the value set from a consumer's perspective. The textual description specifies the span of meanings for concepts to be included within the Value Set Expansion, and also may specify the intended use and limitations of the Value Set. Description SHOULD contain instructions for clinical or administrative use and interpretation and information about misuse. Description SHOULD be populated unless the information is available from context. Description SHOULD be populated unless the value set is a contained resource (e.g. a value set defined solely in the context of a profile).; (xsd)description:markdown>
[]< The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate value set instances. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.; (xsd)useContext:UsageContext>*
[]< A legal or geographic region in which the value set is intended to be used. It may be possible for the value set to be used in jurisdictions other than those for which it was originally designed or intended.
DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.) Binding: jurisdiction (extensible, Countries and regions within which this artifact is targeted for use.); (xsd)jurisdiction:CodeableConcept>*
< If this is set to 'true', then no new versions of the content logical definition can be created. Note: Other metadata might still change. Normally immutability is set to 'false', which is the default assumption if it is not populated. Note that the implication is that if this is set to 'true', there may be only one ValueSet version for this definition. Immutability tends to be set to 'true' in one of two cases: - Where the value set, by the nature of its usage, cannot change. For example "All specializations of ACT in ActClassCode" - Where there's no safe way to express the "Purpose" such that someone else could safely make changes to the value set definition. Source workflow control must guarantee that the same URI always yields the same definition.; (xsd)immutable:boolean>?
< Explanation of why this value set is needed and why it has been designed as it has. This element does not describe the usage of the value set. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this value set.; (xsd)purpose:markdown>?
< A copyright statement relating to the value set and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the value set. Frequently, the copyright differs between the value set and the codes that are included. The copyright statement should clearly differentiate between these when required.; (xsd)copyright:markdown>?
< A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved'). The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.; (xsd)copyrightLabel:string>?
< The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)approvalDate:date>?
< The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. If specified, this date follows the original approval date.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)lastReviewDate:date>?
< The period during which the ValueSet content was or is planned to be in active use. The effective period for a ValueSet determines when the content is applicable for usage and is independent of publication and review dates. For example, a valueset intended to be used for the year 2016 might be published in 2015.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)effectivePeriod:Period>?
[]< Descriptions related to the content of the ValueSet. Topics provide a high-level categorization as well as keywords for the ValueSet that can be useful for filtering and searching. DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'topic' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#topic and useContext.valueCodeableConcept indicating the topic) Binding: definition-topic (example, ); (xsd)topic:CodeableConcept>*
[]< An individiual or organization primarily involved in the creation and maintenance of the ValueSet.; (xsd)author:ContactDetail>*
[]< An individual or organization primarily responsible for internal coherence of the ValueSet.; (xsd)editor:ContactDetail>*
[]< An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the ValueSet. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)reviewer:ContactDetail>*
[]< An individual or organization asserted by the publisher to be responsible for officially endorsing the ValueSet for use in some setting. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)endorser:ContactDetail>*
[]< Related artifacts such as additional documentation, justification, dependencies, bibliographic references, and predecessor and successor artifacts. Each related artifact is either an attachment, or a reference to another resource, but not both.; (xsd)relatedArtifact:RelatedArtifact>*
< A set of criteria that define the contents of the value set by including or excluding codes selected from the specified code system(s) that the value set draws from. This is also known as the Content Logical Definition (CLD).; (xsd)compose:shareablevalueset.compose>?
< A value set can also be "expanded", where the value set is turned into a simple collection of enumerated codes. This element holds the expansion, if it has been performed. Expansion is performed to produce a collection of codes that are ready to use for data entry or validation. Value set expansions are always considered to be stateless - they are a record of the set of codes in the value set at a point in time under a given set of conditions, and are not subject to ongoing maintenance.
Expansion.parameter is a simplified list of parameters - a subset of the features of the [Parameters](parameters.html) resource.; (xsd)expansion:shareablevalueset.expansion>?
< Description of the semantic space the Value Set Expansion is intended to cover and should further clarify the text in ValueSet.description.; (xsd)scope:shareablevalueset.scope>?
[]< Defines a knowledge representation level provided by this knowledge artifact.; (xsd)knowledgeRepresentationLevel:Extension>*
< A reference to the authoritative accessible, persisted source of truth of the entire Value Set Definition, including textual information and available versions. If this extension is not present, then the canonical URL (ValueSet.url) also serves the purpose of specifying the authoritative source. A difference between the canonical URL and the authoritiative source might arise in some cases due to ongoing organization restructuring, etc., and in those cases this extension may be used. The URL of the authoritative source is intended to be resolvable but that cannot be guaranteed. The designated "authoritative source" is normally expected to be able to generate a valid expansion of the value set, and if for some reason it cannot then the valueset-trusted-expansion should be used.; (xsd)authoritativeSource:Extension>?🔗 A set of criteria that define the contents of the value set by including or excluding codes selected from the specified code system(s) that the value set draws from. This is also known as the Content Logical Definition (CLD).shareablevalueset.compose(xsd)(doc)=
<#base:ValueSet.compose>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The Locked Date is the effective date that is used to determine the version of all referenced Code Systems and Value Set Definitions included in the compose that are not already tied to a specific version. With a defined lockedDate the value set is considered "Locked". Otherwise, the value set may have different expansions as underlying code systems and/or value sets evolve. The interpretation of lockedDate is often dependent on the context - e.g. a SNOMED CT derived value set with a lockedDate will have a different expansion in USA than in UK. If a value set specifies a version for include and exclude statements, and also specifies a locked date, the specified versions need to be available that date, or the value set will not be usable.; (xsd)lockedDate:date>?
< Whether inactive codes - codes that are not approved for current use - are in the value set. If inactive = true, inactive codes are to be included in the expansion, if inactive = false, the inactive codes will not be included in the expansion. If absent, the behavior is determined by the implementation, or by the applicable $expand parameters (but generally, inactive codes would be expected to be included). Note that in the FHIR terminology framework, "deprecated" does not mean inactive, but in some code systems, e.g. LOINC, "deprecated" does mean inactive. Code systems should define what codes are considered to be inactive. If this is not clearly defined (including in the FHIR code system resource), then all codes are assumed to be active.
The Value Set Definition specification defines an ActiveOnly element, which is the reverse of this element e.g. (ValueSet.compose.inactive=FALSE) is the same as (VSD.ActiveOnly=TRUE).; (xsd)inactive:boolean>?
[]< Include one or more codes from a code system or other value set(s). All the conditions in an include must be true. If a system is listed, all the codes from the system are listed. If one or more filters are listed, all of the filters must apply. If one or more value sets are listed, the codes must be in all the value sets. E.g. each include is 'include all the codes that meet all these conditions'.; (xsd)include:shareablevalueset.compose.include>+
[]< Exclude one or more codes from the value set based on code system filters and/or other value sets. Usually this is used to selectively exclude codes that were included by subsumption in the inclusions. Any display names specified for the codes are ignored.; (xsd)exclude:ValueSet.compose.include>*
[]< A property to return in the expansion, if the client doesn't ask for any particular properties. May be either a code from the code system definition (convenient) or a the formal URI that refers to the property. The special value '*' means all properties known to the server. Note that property names can clash, so using a URI is recommended.; (xsd)property:string>*🔗 Include one or more codes from a code system or other value set(s). All the conditions in an include must be true. If a system is listed, all the codes from the system are listed. If one or more filters are listed, all of the filters must apply. If one or more value sets are listed, the codes must be in all the value sets. E.g. each include is 'include all the codes that meet all these conditions'.shareablevalueset.compose.include(xsd)(doc)=
<#base:ValueSet.compose.include>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< An absolute URI which is the code system from which the selected codes come from. If there are no codes or filters, the entire code system is included. Note that the set of codes that are included may contain abstract codes. See ''Coding.system'' for further documentation about the correct value for the system element.; (xsd)system:uri>?
< The version of the code system that the codes are selected from, or the special version '*' for all versions. This is used when selecting the descendants of a concept - they may change between versions. If no version is specified, then the exact contents of the value set might not be known until a context of use binds it to a particular version. The special value '*' means all versions; It is at server discretion regarding expansions and which versions must be supported.; (xsd)version:string>?
[]< Specifies a concept to be included or excluded. The list of concepts is considered ordered, though the order might not have any particular significance. Typically, the order of an expansion follows that defined in the compose element.; (xsd)concept:shareablevalueset.compose.include.concept>*
[]< Select concepts by specifying a matching criterion based on the properties (including relationships) defined by the system, or on filters defined by the system. If multiple filters are specified within the include, they SHALL all be true. Selecting codes by specifying filters based on properties is only possible where the underlying code system defines appropriate properties. Note that in some cases, the underlying code system defines the logical concepts but not the literal codes for the concepts. In such cases, the literal definitions may be provided by a third party.; (xsd)filter:shareablevalueset.compose.include.filter>*
[]< Selects the concepts found in this value set (based on its value set definition). This is an absolute URI that is a reference to ValueSet.url. If multiple value sets are specified this includes the intersection of the contents of all of the referenced value sets. The value set URI is either a logical reference to a defined value set such as a [SNOMED CT reference set](https://terminology.hl7.org/SNOMEDCT.html), or a direct reference to a value set definition using ValueSet.url. The reference might not refer to an actual FHIR ValueSet resource; in this case, whatever is referred to is an implicit definition of a value set that needs to be clear about how versions are resolved.; (xsd)valueSet:ValueSet*>*
< A copyright statement for the specific code system asserted by the containing ValueSet.compose.include element's system value (if the associated ValueSet.compose.include.version element is not present); or the code system and version combination (if the associated ValueSet.compose.include.version element is present).; (xsd)copyright:string>?🔗 Specifies a concept to be included or excluded. The list of concepts is considered ordered, though the order might not have any particular significance. Typically, the order of an expansion follows that defined in the compose element.shareablevalueset.compose.include.concept(xsd)(doc)=
<#base:ValueSet.compose.include.concept>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Specifies a code for the concept to be included or excluded. Expressions are allowed if defined by the underlying code system.; (xsd)code>
< The text to display to the user for this concept in the context of this valueset. If no display is provided, then applications using the value set use the display specified for the code by the system. The value set resource allows for an alternative display to be specified for when this concept is used in this particular value set. See notes in the value set narrative about the correct use of this element.; (xsd)display:string>?
[]< Additional representations for this concept when used in this value set - other languages, aliases, specialized purposes, used for particular purposes, etc. Concepts have both a ```display``` and an array of ```designation```. The display is equivalent to a special designation with an implied ```designation.use``` of "primary code" and a language equal to the [Resource Language](resource.html#language).; (xsd)designation:shareablevalueset.compose.include.concept.designation>*🔗 Additional representations for this concept when used in this value set - other languages, aliases, specialized purposes, used for particular purposes, etc. Concepts have both a ```display``` and an array of ```designation```. The display is equivalent to a special designation with an implied ```designation.use``` of "primary code" and a language equal to the [Resource Language](resource.html#language).shareablevalueset.compose.include.concept.designation(xsd)(doc)=
<#base:ValueSet.compose.include.concept.designation>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The language this designation is defined for. In the absence of a language, the resource language applies. Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< A code that represents types of uses of designations. If no use is provided, the designation can be assumed to be suitable for general display to a human user. Binding: designation-use (extensible, Details of how a designation would be used.); (xsd)use:Coding>?
[]< Additional codes that detail how this designation would be used, if there is more than one use. This was added rather than increasing the cardinality of .use to 0..* in order to maintain backward compatibility. Binding: designation-use (extensible, Details of how a designation would be used.); (xsd)additionalUse:Coding>*
< The text value for this designation.; (xsd)value:string>🔗 Select concepts by specifying a matching criterion based on the properties (including relationships) defined by the system, or on filters defined by the system. If multiple filters are specified within the include, they SHALL all be true. Selecting codes by specifying filters based on properties is only possible where the underlying code system defines appropriate properties. Note that in some cases, the underlying code system defines the logical concepts but not the literal codes for the concepts. In such cases, the literal definitions may be provided by a third party.shareablevalueset.compose.include.filter(xsd)(doc)=
<#base:ValueSet.compose.include.filter>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A code that identifies a property or a filter defined in the code system.; (xsd)property:code>
< The kind of operation to perform as a part of the filter criteria. In case filter.property represents a property of the system, the operation applies to the selected property. In case filter.property represents a filter of the system, the operation SHALL match one of the CodeSystem.filter.operator values. Binding: filter-operator (required, The kind of operation to perform as a part of a property based filter.); (xsd)op:code>
< The match value may be either a code defined by the system, or a string value, which is a regex match on the literal string of the property value (if the filter represents a property defined in CodeSystem) or of the system filter value (if the filter represents a filter defined in CodeSystem) when the operation is 'regex', or one of the values (true and false), when the operation is 'exists'. Use regex matching with care - full regex matching on every SNOMED CT term is prohibitive, for example.; (xsd)value:string>🔗 A value set can also be "expanded", where the value set is turned into a simple collection of enumerated codes. This element holds the expansion, if it has been performed. Expansion is performed to produce a collection of codes that are ready to use for data entry or validation. Value set expansions are always considered to be stateless - they are a record of the set of codes in the value set at a point in time under a given set of conditions, and are not subject to ongoing maintenance.
Expansion.parameter is a simplified list of parameters - a subset of the features of the [Parameters](parameters.html) resource.shareablevalueset.expansion(xsd)(doc)=
<#base:ValueSet.expansion>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< An identifier that uniquely identifies this expansion of the valueset, based on a unique combination of the provided parameters, the system default parameters, and the underlying system code system versions etc. Systems may re-use the same identifier as long as those factors remain the same, and the expansion is the same, but are not required to do so. This is a business identifier. Typically, this uri is a UUID (e.g. urn:uuid:8230ff20-c97a-4167-a59d-dc2cb9df16dd).; (xsd)identifier:uri>?
< As per paging Search results, the next URLs are opaque to the client, have no dictated structure, and only the server understands them. Clients SHOULD use the next link, if present, to page through expansion results in preference to using the offset and count parameters. Due to the optional nature of the next link, its absence does not necessarily indicate that it is the last page of results. Instead, as the offset and count parameters SHALL be populated when paging, clients can reliably use the count/offset parameters to determine whether the whole expansion is returned.; (xsd)next:uri>?
< The time at which the expansion was produced by the expanding system. This SHOULD be a fully populated instant, but in some circumstances, value sets are expanded by hand, and the expansion is published without that precision.; (xsd)timestamp:dateTime>
< The total number of concepts in the expansion. If the number of concept nodes in this resource is less than the stated number, then the server can return more using the offset parameter. Paging only applies to flat expansions.; (xsd)total:integer>?
< If paging is being used, the offset at which this resource starts. I.e. this resource is a partial view into the expansion. If paging is not being used, this element SHALL NOT be present. Paging only applies to flat expansions. If a filter is applied, the count is the number of concepts that matched the filter, not the number of concepts in an unfiltered view of the expansion.; (xsd)offset:integer>?
[]< A parameter that controlled the expansion process. These parameters may be used by users of expanded value sets to check whether the expansion is suitable for a particular purpose, or to pick the correct expansion. The server decides which parameters to include here, but at a minimum, the list SHOULD include all of the parameters that affect the $expand operation. If the expansion will be persisted all of these parameters SHALL be included. If the codeSystem on the server has a specified version then this version SHALL be provided as a parameter in the expansion (note that not all code systems have a version).; (xsd)parameter:shareablevalueset.expansion.parameter>*
[]< A property defines an additional slot through which additional information can be provided about a concept.; (xsd)property:shareablevalueset.expansion.property>*
[]< The codes that are contained in the value set expansion.; (xsd)contains:shareablevalueset.expansion.contains>*🔗 The codes that are contained in the value set expansion.shareablevalueset.expansion.contains(xsd)(doc)=
<#base:ValueSet.expansion.contains>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< An absolute URI which is the code system in which the code for this item in the expansion is defined.; (xsd)system:uri>?
< If true, this entry is included in the expansion for navigational purposes, and the user cannot select the code directly as a proper value. This should not be understood to exclude its use for searching (e.g. by subsumption testing). The client should know whether it is appropriate for the user to select an abstract code or not.; (xsd)abstract:boolean>?
< If the concept is inactive in the code system that defines it. Inactive codes are those that are no longer to be used, but are maintained by the code system for understanding legacy data. It might not be known or specified whether a concept is inactive (and it may depend on the context of use). This should only have a value if the concept is inactive.; (xsd)inactive:boolean>?
< The version of the code system from this code was taken. 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. The exact value of the version string is specified by the system from which the code is derived.; (xsd)version:string>?
< The code for this item in the expansion hierarchy. If this code is missing the entry in the hierarchy is a place holder (abstract) and does not represent a valid code in the value set.; (xsd)code>?
< The recommended display for this item in the expansion.; (xsd)display:string>?
[]< Additional representations for this item - other languages, aliases, specialized purposes, used for particular purposes, etc. These are relevant when the conditions of the expansion do not fix to a single correct representation. The designations provided must be based on the value set and code system definitions.; (xsd)designation:ValueSet.compose.include.concept.designation>*
[]< A property value for this concept.; (xsd)property:shareablevalueset.expansion.contains.property>*
[]< Other codes and entries contained under this entry in the hierarchy. If the expansion uses this element, there is no implication about the logical relationship between them, and the structure cannot be used for logical inferencing. The structure exists to provide navigational assistance for helping human users to locate codes in the expansion.; (xsd)contains:ValueSet.expansion.contains>*🔗 A property value for this concept.shareablevalueset.expansion.contains.property(xsd)(doc)=
<#base:ValueSet.expansion.contains.property>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A code that is a reference to ValueSet.expansion.property.code.; (xsd)code>
(<valueBoolean:boolean>
|<valueCode:code>
|<valueCoding:Coding>
|<valueDateTime:dateTime>
|<valueDecimal:decimal>
|<valueInteger:integer>
|<valueString:string>)
[]< A subproperty value for this concept.; (xsd)subProperty:shareablevalueset.expansion.contains.property.subProperty>*🔗 A subproperty value for this concept.shareablevalueset.expansion.contains.property.subProperty(xsd)(doc)=
<#base:ValueSet.expansion.contains.property.subProperty>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A code that is a reference to ValueSet.expansion.property.code.; (xsd)code>
(<valueBoolean:boolean>
|<valueCode:code>
|<valueCoding:Coding>
|<valueDateTime:dateTime>
|<valueDecimal:decimal>
|<valueInteger:integer>
|<valueString:string>)🔗 A parameter that controlled the expansion process. These parameters may be used by users of expanded value sets to check whether the expansion is suitable for a particular purpose, or to pick the correct expansion. The server decides which parameters to include here, but at a minimum, the list SHOULD include all of the parameters that affect the $expand operation. If the expansion will be persisted all of these parameters SHALL be included. If the codeSystem on the server has a specified version then this version SHALL be provided as a parameter in the expansion (note that not all code systems have a version).shareablevalueset.expansion.parameter(xsd)(doc)=
<#base:ValueSet.expansion.parameter>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Name of the input parameter to the $expand operation; may be a server-assigned name for additional default or other server-supplied parameters used to control the expansion process. The names are assigned at the discretion of the server.; (xsd)name:string>
(<valueBoolean:boolean>
|<valueCode:code>
|<valueDateTime:dateTime>
|<valueDecimal:decimal>
|<valueInteger:integer>
|<valueString:string>
|<valueUri:uri>)?🔗 A property defines an additional slot through which additional information can be provided about a concept.shareablevalueset.expansion.property(xsd)(doc)=
<#base:ValueSet.expansion.property>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A code that is used to identify the property. The code is used in ValueSet.expansion.contains.property.code.; (xsd)code>
< Reference to the formal meaning of the property. One possible source of meaning is the [Concept Properties](codesystem-concept-properties.html) code system.; (xsd)uri>?🔗 Description of the semantic space the Value Set Expansion is intended to cover and should further clarify the text in ValueSet.description.shareablevalueset.scope(xsd)(doc)=
<#base:ValueSet.scope>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Criteria describing which concepts or codes should be included and why.; (xsd)inclusionCriteria:string>?
< Criteria describing which concepts or codes should be excluded and why.; (xsd)exclusionCriteria:string>?🔗 A container for slots of time that may be available for booking appointments.Schedule(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< External Ids for this item.; (xsd)identifier:Identifier>*
< Whether this schedule record is in active use or should not be used (such as was entered in error). This element is labeled as a modifier because it may be used to mark that the resource was created in error.; (xsd)active:boolean>?
[]< A broad categorization of the service that is to be performed during this appointment. Binding: service-category (example, ); (xsd)serviceCategory:CodeableConcept>*
[]< The specific service that is to be performed during this appointment. Binding: service-type (example, ); (xsd)serviceType:HealthcareService*>*
[]< The specialty of a practitioner that would be required to perform the service requested in this appointment. Binding: c80-practice-codes (preferred, Additional details about where the content was created (e.g. clinical specialty).); (xsd)specialty:CodeableConcept>*
< Further description of the schedule as it would be presented to a consumer while searching. This MAY be used to describe what the schedule is for where it is clearer than just the name of the single actor.; (xsd)name:string>?
[]< Slots that reference this schedule resource provide the availability details to these referenced resource(s). The capacity to support multiple referenced resource types should be used in cases where the specific resources themselves cannot be scheduled without the other, and thus only make sense to the system exposing them as a group. Common examples of this are where the combination of a practitioner and a room (Location) are always required by a system.; (xsd)actor:(<CareTeam>
|<Device>
|<HealthcareService>
|<Location>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>+
< The period of time that the slots that reference this Schedule resource cover (even if none exist). These cover the amount of time that an organization's planning horizon; the interval for which they are currently accepting appointments. This does not define a "template" for planning outside these dates.; (xsd)planningHorizon:Period>?
< Comments on the availability to describe any extended information. Such as custom constraints on the slots that may be associated.; (xsd)comment:markdown>?🔗 An ExtensionScheduleSummary(xsd)(doc)=
<#base:Extension>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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. http://hl7.org/fhir/uv/order-catalog/StructureDefinition/ScheduleSummary; (xsd)url:string>
< Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R5/extensibility.html) for a list).; (xsd)value:string>?🔗 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(xsd)(doc)=
<#base:DataType>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< 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". Binding: signature-type (preferred, An indication of the reason that an entity signed the object.); (xsd)type:Coding>*
< When the digital signature was signed. This should agree with the information in the signature.; (xsd)when:instant>?
< 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.; (xsd)who:(<Device>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>?
< 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.; (xsd)onBehalfOf:(<Device>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>?
< 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. Binding: mimetypes (required, BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)); (xsd)targetFormat:code>?
< 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. Binding: mimetypes (required, BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)); (xsd)sigFormat:code>?
< 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.; (xsd)data:base64Binary>?🔗 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.SimpleQuantity(xsd)(doc)=
<#base:Quantity>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< 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).; (xsd)value:decimal>?
< Not allowed to be used in this context Binding: quantity-comparator (required, How the Quantity should be understood and represented.); (xsd)comparator:code>{0,0}
< A human-readable form of the unit.; (xsd)unit:string>?
< The identification of the system that provides the coded form of the unit.; (xsd)system:uri>?
< 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.; (xsd)code>?🔗 A slot of time on a schedule that may be available for booking appointments.Slot(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< External Ids for this item.; (xsd)identifier:Identifier>*
[]< A broad categorization of the service that is to be performed during this appointment. Binding: service-category (example, ); (xsd)serviceCategory:CodeableConcept>*
[]< The type of appointments that can be booked into this slot (ideally this would be an identifiable service - which is at a location, rather than the location itself). If provided then this overrides the value provided on the Schedule resource. Binding: service-type (example, ); (xsd)serviceType:HealthcareService*>*
[]< The specialty of a practitioner that would be required to perform the service requested in this appointment. Binding: c80-practice-codes (preferred, Additional details about where the content was created (e.g. clinical specialty).); (xsd)specialty:CodeableConcept>*
[]< The style of appointment or patient that may be booked in the slot (not service type). A slot may be allow multiple appointment types, but when booked, would only be used for one of the given appointment types. Binding: http://terminology.hl7.org/ValueSet/v2-0276 (preferred, ); (xsd)appointmentType:CodeableConcept>*
< The schedule resource that this slot defines an interval of status information.; (xsd)schedule:Schedule*>
< busy | free | busy-unavailable | busy-tentative | entered-in-error. Binding: slotstatus (required, The free/busy status of the slot.); (xsd)status:code>
< Date/Time that the slot is to begin.; (xsd)start:instant>
< Date/Time that the slot is to conclude.; (xsd)end:instant>
< This slot has already been overbooked, appointments are unlikely to be accepted for this time.; (xsd)overbooked:boolean>?
< Comments on the slot to describe any extended information. Such as custom constraints on the slot.; (xsd)comment:string>?🔗 A sample to be used for analysis.Specimen(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< Id for specimen.; (xsd)identifier:Identifier>*
< The identifier assigned by the lab when accessioning specimen(s). This is not necessarily the same as the specimen identifier, depending on local lab procedures.; (xsd)accessionIdentifier:Identifier>?
< The availability of the specimen. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. Binding: specimen-status (required, Codes providing the status/availability of a specimen.); (xsd)status:code>?
< The kind of material that forms the specimen. The type can change the way that a specimen is handled and drives what kind of analyses can properly be performed on the specimen. It is frequently used in diagnostic work flow decision making systems. Binding: http://terminology.hl7.org/ValueSet/v2-0487 (example, The type of the specimen.); (xsd)type:CodeableConcept>?
< Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance, a biologically-derived product, or a device.; (xsd)subject:(<BiologicallyDerivedProduct>
|<Device>
|<Group>
|<Location>
|<Patient>
|<Substance>)>?
< Time when specimen is received by the testing laboratory for processing or testing.; (xsd)receivedTime:dateTime>?
[]< Reference to the parent (source) specimen which is used when the specimen was either derived from or a component of another specimen. The parent specimen could be the source from which the current specimen is derived by some processing step (e.g. an aliquot or isolate or extracted nucleic acids from clinical samples) or one of many specimens that were combined to create a pooled sample.; (xsd)parent:Specimen*>*
[]< Details concerning a service request that required a specimen to be collected. The request may be explicit or implied such with a ServiceRequest that requires a blood draw.; (xsd)request:ServiceRequest*>*
< This element signifies if the specimen is part of a group or pooled. Binding: specimen-combined (required, Codes for the combined status of a specimen.); (xsd)combined:code>?
[]< The role or reason for the specimen in the testing workflow. Binding: specimen-role (preferred, Codes describing specimen role.); (xsd)role:CodeableConcept>*
[]< A physical feature or landmark on a specimen, highlighted for context by the collector of the specimen (e.g. surgeon), that identifies the type of feature as well as its meaning (e.g. the red ink indicating the resection margin of the right lobe of the excised prostate tissue or wire loop at radiologically suspected tumor location).; (xsd)feature:Specimen.feature>*
< Details concerning the specimen collection.; (xsd)collection:Specimen.collection>?
[]< Details concerning processing and processing steps for the specimen.; (xsd)processing:Specimen.processing>*
[]< The container holding the specimen. The recursive nature of containers; i.e. blood in tube in tray in rack is not addressed here.; (xsd)container:Specimen.container>*
[]< A mode or state of being that describes the nature of the specimen. Specimen condition is an observation made about the specimen. It's a point-in-time assessment. It can be used to assess its quality or appropriateness for a specific test. Binding: http://terminology.hl7.org/ValueSet/v2-0493 (extensible, Codes describing the state of the specimen.); (xsd)condition:CodeableConcept>*
[]< To communicate any details or issues about the specimen or during the specimen collection. (for example: broken vial, sent with patient, frozen).; (xsd)note:Annotation>*🔗 Details concerning the specimen collection.Specimen.collection(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Person who collected the specimen.; (xsd)collector:(<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>?
< Time when specimen was collected from subject - the physiologically relevant time.; (xsd)collected:(<dateTime>
|<Period>)>?
< The span of time over which the collection of a specimen occurred.; (xsd)duration:Duration>?
< The quantity of specimen collected; for instance the volume of a blood sample, or the physical measurement of an anatomic pathology sample.; (xsd)quantity:SimpleQuantity>?
< A coded value specifying the technique that is used to perform the procedure. Binding: specimen-collection-method (example, The technique that is used to perform the procedure.); (xsd)method:CodeableConcept>?
< A coded value specifying the technique that is used to perform the procedure. Binding: (example, The device that was used to obtain the specimen (e.g. a catheter or catheter part used to draw the blood via a central line).); (xsd)device:Device*>?
< The procedure event during which the specimen was collected (e.g. the surgery leading to the collection of a pathology sample).; (xsd)procedure:Procedure*>?
< Anatomical location from which the specimen was collected (if subject is a patient). This is the target site. This element is not used for environmental specimens. Reasons for using BodyStructure reference include: 1.) Need to identify a specific site instance (e.g. a specific mole), 2.) a single pre-coordinated coded concept for the body site does not exist, 3.) a desire to represent bodySite using multiple attributes (e.g. modifiers). Binding: body-site (example, SNOMED CT Body site concepts); (xsd)bodySite:BodyStructure*>?
< Abstinence or reduction from some or all food, drink, or both, for a period of time prior to sample collection. Representing fasting status using this element is preferred to representing it with an observation using a 'pre-coordinated code' such as LOINC 2005-7 (Calcium [Moles/time] in 2 hour Urine --12 hours fasting), or using a component observation ` such as `Observation.component code` = LOINC 49541-6 (Fasting status - Reported). Binding: http://terminology.hl7.org/ValueSet/v2-0916 (extensible, Codes describing the fasting status of the patient.); (xsd)fastingStatus:(<CodeableConcept>
|<Duration>)>?🔗 The container holding the specimen. The recursive nature of containers; i.e. blood in tube in tray in rack is not addressed here.Specimen.container(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The device resource for the the container holding the specimen. If the container is in a holder then the referenced device will point to a parent device.; (xsd)device:Device*>
< The location of the container holding the specimen.; (xsd)location:Location*>?
< The quantity of specimen in the container; may be volume, dimensions, or other appropriate measurements, depending on the specimen type.; (xsd)specimenQuantity:SimpleQuantity>?🔗 A physical feature or landmark on a specimen, highlighted for context by the collector of the specimen (e.g. surgeon), that identifies the type of feature as well as its meaning (e.g. the red ink indicating the resection margin of the right lobe of the excised prostate tissue or wire loop at radiologically suspected tumor location).Specimen.feature(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The landmark or feature being highlighted. Binding: body-site (example, SNOMED CT Body site concepts); (xsd)type:CodeableConcept>
< Description of the feature of the specimen.; (xsd)description:string>🔗 Details concerning processing and processing steps for the specimen.Specimen.processing(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Textual description of procedure.; (xsd)description:string>?
< A coded value specifying the method used to process the specimen. Binding: specimen-processing-method (example, Type indicating the technique used to process the specimen.); (xsd)method:CodeableConcept>?
[]< Material used in the processing step.; (xsd)additive:Substance*>*
< A record of the time or period when the specimen processing occurred. For example the time of sample fixation or the period of time the sample was in formalin.; (xsd)time:(<dateTime>
|<Period>)>?🔗 A kind of specimen with associated set of requirements.SpecimenDefinition(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< An absolute URL that is used to identify this SpecimenDefinition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this SpecimenDefinition is (or will be) published. The URL SHOULD include the major version of the SpecimenDefinition. For more information see Technical and Business Versions. Can be a urn:uuid: or a urn:oid:, but real http: addresses are preferred. This is the URI that will be used when making canonical references to this resource.; (xsd)url:uri>?
< A business identifier assigned to this SpecimenDefinition.; (xsd)identifier:Identifier>?
< The identifier that is used to identify this version of the SpecimenDefinition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the SpecimenDefinition author and is not expected to be globally unique. There may be multiple different instances of a SpecimenDefinition that have the same identifier but different versions.; (xsd)version:string>?
< Indicates the mechanism used to compare versions to determine which is more current. If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined. Binding: version-algorithm (extensible, ); (xsd)versionAlgorithm:(<Coding>
|<string>)>?
< A natural language name identifying the {{title}}. This name should be usable as an identifier for the module by machine processing applications such as code generation. The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.; (xsd)name:string>?
< A short, descriptive, user-friendly title for the SpecimenDefinition.; (xsd)title:string>?
[]< The canonical URL pointing to another FHIR-defined SpecimenDefinition that is adhered to in whole or in part by this definition.; (xsd)derivedFromCanonical:SpecimenDefinition*>*
[]< The URL pointing to an externally-defined type of specimen, guideline or other definition that is adhered to in whole or in part by this definition.; (xsd)derivedFromUri:uri>*
< The current state of theSpecimenDefinition. A nominal state-transition diagram can be found in the [Definition pattern](definition.html#statemachine) documentation
Unknown does not represent "other" - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization). Binding: publication-status (required, Codes identifying the status of a SpecimenDefinition resource.); (xsd)status:code>
< A flag to indicate that this SpecimenDefinition is not authored for genuine usage. Allows filtering of SpecimenDefinition that are appropriate for use vs. not.; (xsd)experimental:boolean>?
< A code or group definition that describes the intended subject from which this kind of specimen is to be collected. Examples: person, animal, device, water ….; (xsd)subject:(<CodeableConcept>
|<Group>)>?
< For draft definitions, indicates the date of initial creation. For active definitions, represents the date of activation. For withdrawn definitions, indicates the date of withdrawal. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)date:dateTime>?
< Helps establish the "authority/credibility" of the SpecimenDefinition. May also allow for contact.; (xsd)publisher:string>?
[]< Contact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)contact:ContactDetail>*
< A free text natural language description of the SpecimenDefinition from the consumer's perspective. This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the module as conveyed in the text field of the resource itself. This item SHOULD be populated unless the information is available from context.; (xsd)description:markdown>?
[]< The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of specimen definitions. When multiple usageContexts are specified, there is no expectation for whether all or any of the contexts apply.; (xsd)useContext:UsageContext>*
[]< A jurisdiction in which the SpecimenDefinition is intended to be used. DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.) Binding: jurisdiction (extensible, Codes for country, country subdivision and region for indicating where a resource is intended to be used.); (xsd)jurisdiction:CodeableConcept>*
< Explains why this SpecimeDefinition is needed and why it has been designed as it has. This element does not describe the usage of the SpecimenDefinition. Rather it is for traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this SpecimenDefinition.; (xsd)purpose:markdown>?
< Copyright statement relating to the SpecimenDefinition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the SpecimenDefinition.; (xsd)copyright:markdown>?
< A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved'). The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.; (xsd)copyrightLabel:string>?
< The date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usage. The date may be more recent than the approval date because of minor changes / editorial corrections.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)approvalDate:date>?
< The date on which the asset content was last reviewed. Review happens periodically after that, but doesn't change the original approval date. If specified, this is usually after the approval date.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)lastReviewDate:date>?
< The period during which the SpecimenDefinition content was or is planned to be effective. The effective period for a SpecimenDefinition determines when the content is applicable for usage and is independent of publication and review dates.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)effectivePeriod:Period>?
< The kind of material to be collected. Binding: http://terminology.hl7.org/ValueSet/v2-0487 (example, The type of the specimen to be collected.); (xsd)typeCollected:CodeableConcept>?
[]< Preparation of the patient for specimen collection. Binding: prepare-patient-prior-specimen-collection (example, SCT descendants of 703763000 |Precondition value (qualifier value)|); (xsd)patientPreparation:CodeableConcept>*
< Time aspect of specimen collection (duration or offset).; (xsd)timeAspect:string>?
[]< The action to be performed for collecting the specimen. Binding: specimen-collection (example, SCT actions and procedures for specimen collection); (xsd)collection:CodeableConcept>*
[]< Specimen conditioned in a container as expected by the testing laboratory.; (xsd)typeTested:SpecimenDefinition.typeTested>*🔗 Specimen conditioned in a container as expected by the testing laboratory.SpecimenDefinition.typeTested(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Primary of secondary specimen.; (xsd)isDerived:boolean>?
< The kind of specimen conditioned for testing expected by lab. Binding: http://terminology.hl7.org/ValueSet/v2-0487 (example, The type of specimen conditioned in a container for lab testing.); (xsd)type:CodeableConcept>?
< The preference for this type of conditioned specimen. Binding: specimen-contained-preference (required, Degree of preference of a type of conditioned specimen.); (xsd)preference:code>
< The specimen's container.; (xsd)container:SpecimenDefinition.typeTested.container>?
< Requirements for delivery and special handling of this kind of conditioned specimen.; (xsd)requirement:markdown>?
< The usual time that a specimen of this kind is retained after the ordered tests are completed, for the purpose of additional testing.; (xsd)retentionTime:Duration>?
< Specimen can be used by only one test or panel if the value is "true".; (xsd)singleUse:boolean>?
[]< Criterion for rejection of the specimen in its container by the laboratory. Binding: rejection-criteria (example, Criterion for rejection of the specimen by laboratory.); (xsd)rejectionCriterion:CodeableConcept>*
[]< Set of instructions for preservation/transport of the specimen at a defined temperature interval, prior the testing process.; (xsd)handling:SpecimenDefinition.typeTested.handling>*
[]< Where the specimen will be tested: e.g., lab, sector, device or any combination of these. Binding: diagnostic-service-sections (example, Codes specifying where the specimen will be tested.); (xsd)testingDestination:CodeableConcept>*🔗 The specimen's container.SpecimenDefinition.typeTested.container(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The type of material of the container. Examples: glass, plastic, metal. Binding: container-material (example, SCT 32039001 |Glass|, 61088005 |Plastic|, 425620007 |Metal|); (xsd)material:CodeableConcept>?
< The type of container used to contain this kind of specimen. Binding: specimen-container-type (example, SCT descendants of 706041008 |Device for body fluid and tissue collection/transfer/processing (physical object)|); (xsd)type:CodeableConcept>?
< Color of container cap. Binding: container-cap (example, Color of the container cap.); (xsd)cap:CodeableConcept>?
< The textual description of the kind of container.; (xsd)description:markdown>?
< The capacity (volume or other measure) of this kind of container.; (xsd)capacity:SimpleQuantity>?
< The minimum volume to be conditioned in the container.; (xsd)minimumVolume:(<SimpleQuantity>
|<string>)>?
[]< Substance introduced in the kind of container to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA.; (xsd)additive:SpecimenDefinition.typeTested.container.additive>*
< Special processing that should be applied to the container for this kind of specimen.; (xsd)preparation:markdown>?🔗 Substance introduced in the kind of container to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA.SpecimenDefinition.typeTested.container.additive(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Substance introduced in the kind of container to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA. Binding: http://terminology.hl7.org/ValueSet/v2-0371 (example, Substance added to specimen container.); (xsd)additive:(<CodeableConcept>
|<SubstanceDefinition>)>🔗 Set of instructions for preservation/transport of the specimen at a defined temperature interval, prior the testing process.SpecimenDefinition.typeTested.handling(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< It qualifies the interval of temperature, which characterizes an occurrence of handling. Conditions that are not related to temperature may be handled in the instruction element. Binding: handling-condition (example, Set of handling instructions prior testing of the specimen.); (xsd)temperatureQualifier:CodeableConcept>?
< The temperature interval for this set of handling instructions.; (xsd)temperatureRange:Range>?
< The maximum time interval of preservation of the specimen with these conditions.; (xsd)maxDuration:Duration>?
< Additional textual instructions for the preservation or transport of the specimen. For instance, 'Protect from light exposure'.; (xsd)instruction:markdown>?🔗 An ExtensionSpecimenRequested(xsd)(doc)=
<#base:Extension>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< An Extension; (xsd)extension: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. http://hl7.org/fhir/uv/order-catalog/StructureDefinition/SpecimenRequested; (xsd)url:string>
(<valueAddress:Address>
|<valueAge:Age>
|<valueAnnotation:Annotation>
|<valueAttachment:Attachment>
|<valueAvailability:Availability>
|<valueBase64Binary:base64Binary>
|<valueBoolean:boolean>
|<valueCode:code>
|<valueCodeableConcept:CodeableConcept>
|<valueCoding:Coding>
|<valueContactDetail:ContactDetail>
|<valueContactPoint:ContactPoint>
|<valueCount:Count>
|<valueDataRequirement:DataRequirement>
|<valueDate:date>
|<valueDateTime:dateTime>
|<valueDecimal:decimal>
|<valueDistance:Distance>
|<valueDosage:Dosage>
|<valueDuration:Duration>
|<valueExpression:Expression>
|<valueExtendedContactDetail:ExtendedContactDetail>
|<valueHumanName:HumanName>
|<valueId:id>
|<valueIdentifier:Identifier>
|<valueInstant:instant>
|<valueInteger:integer>
|<valueInteger64:integer64>
|<valueMarkdown:markdown>
|<valueMeta:Meta>
|<valueMoney:Money>
|<valueOid:oid>
|<valueParameterDefinition:ParameterDefinition>
|<valuePeriod:Period>
|<valuePositiveInt:positiveInt>
|<valueQuantity:Quantity>
|<valueRange:Range>
|<valueRatio:Ratio>
|<valueRatioRange:RatioRange>
|<valueRelatedArtifact:RelatedArtifact>
|<valueResource:Resource>
|<valueSampledData:SampledData>
|<valueSignature:Signature>
|<valueString:string>
|<valueTime:time>
|<valueTiming:Timing>
|<valueTriggerDefinition:TriggerDefinition>
|<valueUnsignedInt:unsignedInt>
|<valueUri:uri>
|<valueUrl:url>
|<valueUsageContext:UsageContext>
|<valueUuid:uuid>){0,0}
[]< A group of specimens requested that must all be provided in case this group is chosen at specimen collection time. In case multiple groups are defined, these groups are mutually exclusive: one and only one group must be chosen at specimen collection time.; (xsd)ExclusiveGroup:SpecimenRequested.ExclusiveGroup>+🔗 A group of specimens requested that must all be provided in case this group is chosen at specimen collection time. In case multiple groups are defined, these groups are mutually exclusive: one and only one group must be chosen at specimen collection time.SpecimenRequested.ExclusiveGroup(xsd)(doc)=
<#base:Extension>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< An Extension; (xsd)extension: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. ExclusiveGroup; (xsd)url:string>
(<valueAddress:Address>
|<valueAge:Age>
|<valueAnnotation:Annotation>
|<valueAttachment:Attachment>
|<valueAvailability:Availability>
|<valueBase64Binary:base64Binary>
|<valueBoolean:boolean>
|<valueCode:code>
|<valueCodeableConcept:CodeableConcept>
|<valueCoding:Coding>
|<valueContactDetail:ContactDetail>
|<valueContactPoint:ContactPoint>
|<valueCount:Count>
|<valueDataRequirement:DataRequirement>
|<valueDate:date>
|<valueDateTime:dateTime>
|<valueDecimal:decimal>
|<valueDistance:Distance>
|<valueDosage:Dosage>
|<valueDuration:Duration>
|<valueExpression:Expression>
|<valueExtendedContactDetail:ExtendedContactDetail>
|<valueHumanName:HumanName>
|<valueId:id>
|<valueIdentifier:Identifier>
|<valueInstant:instant>
|<valueInteger:integer>
|<valueInteger64:integer64>
|<valueMarkdown:markdown>
|<valueMeta:Meta>
|<valueMoney:Money>
|<valueOid:oid>
|<valueParameterDefinition:ParameterDefinition>
|<valuePeriod:Period>
|<valuePositiveInt:positiveInt>
|<valueQuantity:Quantity>
|<valueRange:Range>
|<valueRatio:Ratio>
|<valueRatioRange:RatioRange>
|<valueRelatedArtifact:RelatedArtifact>
|<valueResource:Resource>
|<valueSampledData:SampledData>
|<valueSignature:Signature>
|<valueString:string>
|<valueTime:time>
|<valueTiming:Timing>
|<valueTriggerDefinition:TriggerDefinition>
|<valueUnsignedInt:unsignedInt>
|<valueUri:uri>
|<valueUrl:url>
|<valueUsageContext:UsageContext>
|<valueUuid:uuid>){0,0}
[]< A reference to a SpecimenDefinition resource representing the material When multiple materials are present under an exclusive group, all are requested.; (xsd)Material:SpecimenRequested.ExclusiveGroup.Material>+🔗 A reference to a SpecimenDefinition resource representing the material When multiple materials are present under an exclusive group, all are requested.SpecimenRequested.ExclusiveGroup.Material(xsd)(doc)=
<#base:Extension>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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. Material; (xsd)url:string>
< A reference to SpecimenDefinition as constrained by the LabSpecimenDefinition profile; (xsd)value:LabSpecimenDefinition*>?🔗 A sequence of Unicode characters Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in sizestring(xsd)(doc)=
<#base:PrimitiveType>
< unique id for the element within a resource (for internal references); (xsd)id:string>?
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< The actual value; (xsd)value:string>?🔗 A definition of a FHIR structure. This resource is used to describe the underlying resources, data types defined in FHIR, and also for describing extensions and constraints on resources and data types.StructureDefinition(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< An absolute URI that is used to identify this structure definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this structure definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the structure definition is stored on different servers. Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.
The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions).
In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.; (xsd)url:uri>
[]< A formal identifier that is used to identify this structure definition when it is represented in other formats, or referenced in a specification, model, design or an instance. Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this structure definition outside of FHIR, where it is not possible to use the logical URI.; (xsd)identifier:Identifier>*
< The identifier that is used to identify this version of the structure definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the structure definition author and is not expected to be globally unique. There is no expectation that versions can be placed in a lexicographical sequence, so authors are encouraged to populate the StructureDefinition.versionAlgorithm[x] element to enable comparisons. If there is no managed version available, authors can consider using ISO date/time syntax (e.g., '2023-01-01'). There may be different structure definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the structure definition with the format [url]|[version]. The version SHOULD NOT contain a '#' - see [Business Version](resource.html#bv-format).; (xsd)version:string>?
< Indicates the mechanism used to compare versions to determine which is more current. If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined. Binding: version-algorithm (extensible, ); (xsd)versionAlgorithm:(<Coding>
|<string>)>?
< A natural language name identifying the structure definition. This name should be usable as an identifier for the module by machine processing applications such as code generation. The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.Some Examples:
* O2SatObservation
* PresentationReport
* Immunization2
* AcmeAdmissionRecordOld.; (xsd)name:string>
< A short, descriptive, user-friendly title for the structure definition. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.Applications don't have to use this name but can always fall back to it. The title also corresponds to the label for the root element.; (xsd)title:string>?
< The status of this structure definition. Enables tracking the life-cycle of the content. Allows filtering of structure definitions that are appropriate for use versus not.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization). Binding: publication-status (required, The lifecycle status of an artifact.); (xsd)status:code>
< A Boolean value to indicate that this structure definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. Allows filtering of structure definitions that are appropriate for use versus not.; (xsd)experimental:boolean>?
< The date (and optionally time) when the structure definition was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the structure definition changes. The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the structure definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)date:dateTime>?
< The name of the organization or individual responsible for the release and ongoing maintenance of the structure definition. Usually an organization but may be an individual. The publisher (or steward) of the structure definition is the organization or individual primarily responsible for the maintenance and upkeep of the structure definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the structure definition. This item SHOULD be populated unless the information is available from context.; (xsd)publisher:string>?
[]< Contact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)contact:ContactDetail>*
< A free text natural language description of the structure definition from a consumer's perspective. This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the structure definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the structure definition is presumed to be the predominant language in the place the structure definition was created).; (xsd)description:markdown>?
[]< The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate structure definition instances. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.; (xsd)useContext:UsageContext>*
[]< A legal or geographic region in which the structure definition is intended to be used. It may be possible for the structure definition to be used in jurisdictions other than those for which it was originally designed or intended.
DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.) Binding: jurisdiction (extensible, Countries and regions within which this artifact is targeted for use.); (xsd)jurisdiction:CodeableConcept>*
< Explanation of why this structure definition is needed and why it has been designed as it has. This element does not describe the usage of the structure definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this structure definition.; (xsd)purpose:markdown>?
< A copyright statement relating to the structure definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the structure definition. The short copyright declaration (e.g. (c) '2015+ xyz organization' should be sent in the copyrightLabel element. ...; (xsd)copyright:markdown>?
< A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved'). The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.; (xsd)copyrightLabel:string>?
[]< (DEPRECATED) A set of key words or terms from external terminologies that may be used to assist with indexing and searching of templates nby describing the use of this structure definition, or the content it describes. Note that this element is deprecated. Use the [http://hl7.org/fhir/StructureDefinition/artifact-topic](http://hl7.org/fhir/extensions/StructureDefinition-artifact-topic.html) extension instead. Binding: definition-use (extensible, Codes for the meaning of the defined structure (SNOMED CT and LOINC codes, as an example).); (xsd)keyword:Coding>*
< The version of the FHIR specification on which this StructureDefinition is based - this is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 4.6.0. for this version. A StructureDefinition does not need to specify the target it applies to as StructureDefinitions will often be valid across multiple versions of FHIR. FHIR tooling can determine whether a StructureDefinition is consistent with a particular StructureDefinition if desired. Binding: FHIR-version (required, All published FHIR Versions.); (xsd)fhirVersion:code>?
[]< An external specification that the content is mapped to.; (xsd)mapping:StructureDefinition.mapping>*
< Defines the kind of structure that this definition is describing. Binding: structure-definition-kind (required, Defines the type of structure that a definition is describing.); (xsd)kind:code>
< Whether structure this definition describes is abstract or not - that is, whether the structure is not intended to be instantiated. For Resources and Data types, abstract types will never be exchanged between systems. Abstract Resources cannot be instantiated - a concrete sub-type must be used. Abstract datatypes and extensions cannot be used in an instance. For logical models, the exact implication of "abstract" will rest with the author, depending how the logical model is used. Flagging a constraint structure as abstract conveys design intent but makes no difference to how the structure definition is handled. Note that inline declared elements that are given the type "Element" in the StructureDefinition, but have children described, are anonymous concrete types that specialize Element.; (xsd)abstract:boolean>
[]< Identifies the types of resource or data type elements to which the extension can be applied. For more guidance on using the 'context' element, see the [defining extensions page](defining-extensions.html#context).; (xsd)context:StructureDefinition.context>*
[]< A set of rules as FHIRPath Invariants about when the extension can be used (e.g. co-occurrence variants for the extension). All the rules must be true. The rules are only evaluated when the extension is present. When evaluating the invariant, the FHIRPath focus is the element that holds the extension, and %extension refers to the extension itself.; (xsd)contextInvariant:string>*
< The type this structure describes. If the derivation kind is 'specialization' then this is the master definition for a type, and there is always one of these (a data type, an extension, a resource, including abstract ones). Otherwise the structure definition is a constraint on the stated type (and in this case, the type cannot be an abstract type). 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, where they are required. Note that in the case of constraints, the type could be determined by chasing through the baseDefinition references until a type defining structure (derivation = specialization) is reached, or by looking at the path of the first element in the snapshot - if present - but providing the type directly makes for simpler tooling and indexing.
The type must match the elements defined in the differential and the snapshot. For all FHIR defined types, the path name of the element will start with the type name. For logical models, where the type SHALL be a fully specified URL, the type name SHOULD start with the final path segment of the type URL where required. E.g. If the type was "http://example.org/fhir/MyLogicalModelType", the type name should start with 'MyLogicalModelType'. Binding: fhir-types (extensible, Either a resource or a data type, including logical model types.); (xsd)type:uri>
< An absolute URI that is the base structure from which this type is derived, either by specialization or constraint. If differential constraints are specified in this structure, they are applied to the base in a "differential" fashion. If there is no base, then the differential constraints cannot be provided (snapshot only). Differential structures are useful for the editing perspective, and snapshot structures are suitable for operational use. The FHIR Project provides a number of tools/services to populate snapshots from differential constraints. Logical Models have a base of "Base", "Element" or another logical model.; (xsd)baseDefinition:StructureDefinition*>?
< How the type relates to the baseDefinition. If the definition is a specialization, then it adds to the differential new elements and optionally additional rules to an existing concrete type, and the snapshot includes the inherited elements and rules. If the definition is a constraint, then it cannot define new elements, it can only make new rules about existing content (see [Profiling Resources](profiling.html#resources)). Binding: type-derivation-rule (required, How a type relates to its baseDefinition.); (xsd)derivation:code>?
< A snapshot view is expressed in a standalone form that can be used and interpreted without considering the base StructureDefinition.; (xsd)snapshot:StructureDefinition.snapshot>?
< A differential view is expressed relative to the base StructureDefinition - a statement of differences that it applies.; (xsd)differential:StructureDefinition.differential>?🔗 Identifies the types of resource or data type elements to which the extension can be applied. For more guidance on using the 'context' element, see the [defining extensions page](defining-extensions.html#context).StructureDefinition.context(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Defines how to interpret the expression that defines what the context of the extension is. Binding: extension-context-type (required, How an extension context is interpreted.); (xsd)type:code>
< An expression that defines where an extension can be used in resources.; (xsd)expression:string>🔗 A differential view is expressed relative to the base StructureDefinition - a statement of differences that it applies.StructureDefinition.differential(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< Captures constraints on each element within the resource.; (xsd)element:ElementDefinition>+🔗 An external specification that the content is mapped to.StructureDefinition.mapping(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< An Internal id that is used to identify this mapping set when specific mappings are made. The specification is described once, with general comments, and then specific mappings are made that reference this declaration.; (xsd)identity:id>
< An absolute URI that identifies the specification that this mapping is expressed to. A formal identity for the specification being mapped to helps with identifying maps consistently.; (xsd)uri>?
< A name for the specification that is being mapped to.; (xsd)name:string>?
< Comments about this mapping, including version notes, issues, scope limitations, and other important notes for usage.; (xsd)comment:string>?🔗 A snapshot view is expressed in a standalone form that can be used and interpreted without considering the base StructureDefinition.StructureDefinition.snapshot(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< Captures constraints on each element within the resource.; (xsd)element:ElementDefinition>+🔗 A Map of relationships between 2 structures that can be used to transform data.StructureMap(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< An absolute URI that is used to identify this structure map when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this structure map is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the structure map is stored on different servers. Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.
The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions).
In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.; (xsd)url:uri>
[]< A formal identifier that is used to identify this structure map when it is represented in other formats, or referenced in a specification, model, design or an instance. Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this structure map outside of FHIR, where it is not possible to use the logical URI.; (xsd)identifier:Identifier>*
< The identifier that is used to identify this version of the structure map when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the structure map author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. There may be different structure map instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the structure map with the format [url]|[version]. The version SHOULD NOT contain a '#' - see [Business Version](resource.html#bv-format).; (xsd)version:string>?
< Indicates the mechanism used to compare versions to determine which is more current. If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined. Binding: version-algorithm (extensible, ); (xsd)versionAlgorithm:(<Coding>
|<string>)>?
< A natural language name identifying the structure map. This name should be usable as an identifier for the module by machine processing applications such as code generation. The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.; (xsd)name:string>
< A short, descriptive, user-friendly title for the structure map. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.; (xsd)title:string>?
< The status of this structure map. Enables tracking the life-cycle of the content. Allows filtering of structure maps that are appropriate for use versus not.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization). Binding: publication-status (required, The lifecycle status of an artifact.); (xsd)status:code>
< A Boolean value to indicate that this structure map is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. Allows filtering of structure maps that are appropriate for use versus not.; (xsd)experimental:boolean>?
< The date (and optionally time) when the structure map was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the structure map changes. The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the structure map. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)date:dateTime>?
< The name of the organization or individual responsible for the release and ongoing maintenance of the structure map. Usually an organization but may be an individual. The publisher (or steward) of the structure map is the organization or individual primarily responsible for the maintenance and upkeep of the structure map. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the structure map. This item SHOULD be populated unless the information is available from context.; (xsd)publisher:string>?
[]< Contact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)contact:ContactDetail>*
< A free text natural language description of the structure map from a consumer's perspective. This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the structure map as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the structure map is presumed to be the predominant language in the place the structure map was created).; (xsd)description:markdown>?
[]< The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate structure map instances. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.; (xsd)useContext:UsageContext>*
[]< A legal or geographic region in which the structure map is intended to be used. It may be possible for the structure map to be used in jurisdictions other than those for which it was originally designed or intended.
DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.) Binding: jurisdiction (extensible, Countries and regions within which this artifact is targeted for use.); (xsd)jurisdiction:CodeableConcept>*
< Explanation of why this structure map is needed and why it has been designed as it has. This element does not describe the usage of the structure map. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this structure map.; (xsd)purpose:markdown>?
< A copyright statement relating to the structure map and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the structure map. ...; (xsd)copyright:markdown>?
< A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved'). The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.; (xsd)copyrightLabel:string>?
[]< A structure definition used by this map. The structure definition may describe instances that are converted, or the instances that are produced. It is not necessary for a structure map to identify any dependent structures, though not listing them may restrict its usefulness.; (xsd)structure:StructureMap.structure>*
[]< Other maps used by this map (canonical URLs).; (xsd)import:StructureMap*>*
[]< Definition of a constant value used in the map rules.; (xsd)const:StructureMap.const>*
[]< Organizes the mapping into managable chunks for human review/ease of maintenance.; (xsd)group:StructureMap.group>+🔗 Definition of a constant value used in the map rules.StructureMap.const(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Other maps used by this map (canonical URLs).; (xsd)name:id>?
< A FHIRPath expression that is the value of this variable.; (xsd)value:string>?🔗 Organizes the mapping into managable chunks for human review/ease of maintenance.StructureMap.group(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A unique name for the group for the convenience of human readers.; (xsd)name:id>
< Another group that this group adds rules to.; (xsd)extends:id>?
< If this is the default rule set to apply for the source type or this combination of types. Not applicable if the underlying model is untyped. There can only be one default mapping for any particular type combination. Binding: map-group-type-mode (required, If this is the default rule set to apply for the source type, or this combination of types.); (xsd)typeMode:code>?
< Additional supporting documentation that explains the purpose of the group and the types of mappings within it.; (xsd)documentation:string>?
[]< A name assigned to an instance of data. The instance must be provided when the mapping is invoked. If no inputs are named, then the entry mappings are type based.; (xsd)input:StructureMap.group.input>+
[]< Transform Rule from source to target.; (xsd)rule:StructureMap.group.rule>*🔗 A name assigned to an instance of data. The instance must be provided when the mapping is invoked. If no inputs are named, then the entry mappings are type based.StructureMap.group.input(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Name for this instance of data.; (xsd)name:id>
< Type for this instance of data.; (xsd)type:string>?
< Mode for this instance of data. Binding: map-input-mode (required, Mode for this instance of data.); (xsd)mode:code>
< Documentation for this instance of data.; (xsd)documentation:string>?🔗 Transform Rule from source to target.StructureMap.group.rule(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Name of the rule for internal references.; (xsd)name:id>?
[]< Source inputs to the mapping.; (xsd)source:StructureMap.group.rule.source>+
[]< Content to create because of this mapping rule.; (xsd)target:StructureMap.group.rule.target>*
[]< Rules contained in this rule.; (xsd)rule:StructureMap.group.rule>*
[]< Which other rules to apply in the context of this rule.; (xsd)dependent:StructureMap.group.rule.dependent>*
< Documentation for this instance of data.; (xsd)documentation:string>?🔗 Which other rules to apply in the context of this rule.StructureMap.group.rule.dependent(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Name of a rule or group to apply.; (xsd)name:id>
[]< Parameter to pass to the rule or group.; (xsd)parameter:StructureMap.group.rule.target.parameter>+🔗 Source inputs to the mapping.StructureMap.group.rule.source(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Type or variable this rule applies to.; (xsd)context:id>
< Specified minimum cardinality for the element. This is optional; if present, it acts an implicit check on the input content.; (xsd)min:integer>?
< Specified maximum cardinality for the element - a number or a "*". This is optional; if present, it acts an implicit check on the input content (* just serves as documentation; it's the default value).; (xsd)max:string>?
< Specified type for the element. This works as a condition on the mapping - use for polymorphic elements.; (xsd)type:string>?
< A value to use if there is no existing value in the source object. If there's a default value on an item that can repeat, it will only be used once.; (xsd)defaultValue:string>?
< Optional field for this source.; (xsd)element:string>?
< How to handle the list mode for this element. Binding: map-source-list-mode (required, If field is a list, how to manage the source.); (xsd)listMode:code>?
< Named context for field, if a field is specified.; (xsd)variable:id>?
< FHIRPath expression - must be true or the rule does not apply.; (xsd)condition:string>?
< FHIRPath expression - must be true or the mapping engine throws an error instead of completing.; (xsd)check:string>?
< A FHIRPath expression which specifies a message to put in the transform log when content matching the source rule is found. This is typically used for recording that something Is not transformed to the target for some reason.; (xsd)logMessage:string>?🔗 Content to create because of this mapping rule.StructureMap.group.rule.target(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Variable this rule applies to.; (xsd)context:string>?
< Field to create in the context.; (xsd)element:string>?
< Named context for field, if desired, and a field is specified.; (xsd)variable:id>?
[]< If field is a list, how to manage the list. Binding: map-target-list-mode (required, If field is a list, how to manage the production.); (xsd)listMode:code>*
< Internal rule reference for shared list items.; (xsd)listRuleId:id>?
< How the data is copied / created. Binding: map-transform (required, How data is copied/created.); (xsd)transform:code>?
[]< Parameters to the transform.; (xsd)parameter:StructureMap.group.rule.target.parameter>*🔗 Parameters to the transform.StructureMap.group.rule.target.parameter(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
(<valueBoolean:boolean>
|<valueDate:date>
|<valueDateTime:dateTime>
|<valueDecimal:decimal>
|<valueId:id>
|<valueInteger:integer>
|<valueString:string>
|<valueTime:time>)🔗 A structure definition used by this map. The structure definition may describe instances that are converted, or the instances that are produced. It is not necessary for a structure map to identify any dependent structures, though not listing them may restrict its usefulness.StructureMap.structure(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The canonical reference to the structure.; (xsd)url:StructureDefinition*>
< How the referenced structure is used in this mapping. Binding: map-model-mode (required, How the referenced structure is used in this mapping.); (xsd)mode:code>
< The name used for this type in the map. This is needed if both types have the same name (e.g. version conversion).; (xsd)alias:string>?
< Documentation that describes how the structure is used in the mapping.; (xsd)documentation:string>?🔗 The subscription resource describes a particular client's request to be notified about a SubscriptionTopic.Subscription(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< A formal identifier that is used to identify this code system when it is represented in other formats, or referenced in a specification, model, design or an instance.; (xsd)identifier:Identifier>*
< A natural language name identifying the subscription.; (xsd)name:string>?
< The status of the subscription, which marks the server state for managing the subscription. A client can only submit subscription resources in the requested or off state. Only the server can move a subscription from requested to active, and then to error. Either the server or the client can turn a subscription off.
This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. Binding: subscription-status (required, The status of a subscription.); (xsd)status:code>
< The reference to the subscription topic to be notified about.; (xsd)topic:SubscriptionTopic*>
[]< Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.; (xsd)contact:ContactPoint>*
< The time for the server to turn the subscription off. The server is permitted to deviate from this time but should observe it.; (xsd)end:instant>?
< Entity with authorization to make subsequent revisions to the Subscription and also determines what data the subscription is authorized to disclose.; (xsd)managingEntity:(<CareTeam>
|<HealthcareService>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>?
< A description of why this subscription is defined.; (xsd)reason:string>?
[]< The filter properties to be applied to narrow the subscription topic stream. When multiple filters are applied, evaluates to true if all the conditions applicable to that resource are met; otherwise it returns false (i.e., logical AND).; (xsd)filterBy:Subscription.filterBy>*
< The type of channel to send notifications on. Binding: subscription-channel-type (extensible, The type of method used to execute a subscription.); (xsd)channelType:Coding>
< The url that describes the actual end-point to send notifications to. For rest-hook the end-point must be an `http:` or `https:` URL; for websockets, `ws:` or `wss:`; for email, a `mailto:` url; and for message the endpoint can be in any form of url the server understands (usually, `http/s`: or `mllp:`). The URI is allowed to be relative; in which case, it is relative to the server end-point (since there may be more than one, clients should avoid using relative URIs).; (xsd)endpoint:url>?
[]< Channel-dependent information to send as part of the notification (e.g., HTTP Headers). Exactly what these mean depend on the channel type. They can convey additional information to the server or recipient and/or meet security requirements; for example, support of multiple headers in the outgoing notifications for rest-hook type subscriptions. Note that names are not required to be unique, but channel definitions can impose restrictions.; (xsd)parameter:Subscription.parameter>*
< If present, a 'heartbeat' notification (keep-alive) is sent via this channel with an interval period equal to this elements integer value in seconds. If not present, a heartbeat notification is not sent.; (xsd)heartbeatPeriod:unsignedInt>?
< If present, the maximum amount of time a server will allow before failing a notification attempt.; (xsd)timeout:unsignedInt>?
< The MIME type to send the payload in - e.g., `application/fhir+xml` or `application/fhir+json`. Note that:
* clients may request notifications in a specific FHIR version by using the [FHIR Version Parameter](http.html#version-parameter) - e.g., `application/fhir+json; fhirVersion=4.0`.
* additional MIME types can be allowed by channels - e.g., `text/plain` and `text/html` are defined by the Email channel. Binding: mimetypes (required, BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)); (xsd)contentType:code>?
< How much of the resource content to deliver in the notification payload. The choices are an empty payload, only the resource id, or the full resource content. Sending the payload has obvious security implications. The server is responsible for ensuring that the content is appropriately secured. Binding: subscription-payload-content (required, Codes to represent how much resource content to send in the notification payload.); (xsd)content:code>?
< If present, the maximum number of events that will be included in a notification bundle. Note that this is not a strict limit on the number of entries in a bundle, as dependent resources can be included.; (xsd)maxCount:positiveInt>?🔗 The filter properties to be applied to narrow the subscription topic stream. When multiple filters are applied, evaluates to true if all the conditions applicable to that resource are met; otherwise it returns false (i.e., logical AND).Subscription.filterBy(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A resource listed in the `SubscriptionTopic` this `Subscription` references (`SubscriptionTopic.canFilterBy.resource`). This element can be used to differentiate filters for topics that include more than one resource type. Binding: subscription-types (extensible, A type of resource, or a Reference (from all versions)); (xsd)resourceType:uri>?
< The filter as defined in the `SubscriptionTopic.canFilterBy.filterParameter` element.; (xsd)filterParameter:string>
< Comparator applied to this filter parameter. Must be a comparator allowed by the SubscriptionTopic relevant to this Subscription filter. Binding: search-comparator (required, Search Comparator Codes applied to this filter.); (xsd)comparator:code>?
< Modifier applied to this filter parameter. Must be a modifier allowed by the SubscriptionTopic relevant to this Subscription filter. Binding: search-modifier-code (required, Search Modifier Code applied to this filter.); (xsd)modifier:code>?
< The literal value or resource path as is legal in search - for example, `Patient/123` or `le1950`.; (xsd)value:string>🔗 Channel-dependent information to send as part of the notification (e.g., HTTP Headers). Exactly what these mean depend on the channel type. They can convey additional information to the server or recipient and/or meet security requirements; for example, support of multiple headers in the outgoing notifications for rest-hook type subscriptions. Note that names are not required to be unique, but channel definitions can impose restrictions.Subscription.parameter(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Parameter name for information passed to the channel for notifications, for example in the case of a REST hook wanting to pass through an authorization header, the name would be Authorization.; (xsd)name:string>
< Parameter value for information passed to the channel for notifications, for example in the case of a REST hook wanting to pass through an authorization header, the value would be `Bearer 0193...`.; (xsd)value:string>🔗 A container for a collection of resources.subscription-notification-bundle(xsd)(doc)=
<#base:Bundle>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< A persistent identifier for the bundle that won't change as a bundle is copied from server to server. Persistent identity generally only matters for batches of type Document, Message, and Collection. It would not normally be populated for search and history results and servers ignore Bundle.identifier when processing batches and transactions. For Documents the .identifier SHALL be populated such that the .identifier is globally unique.; (xsd)identifier:Identifier>?
< Indicates the purpose of this bundle - how it is intended to be used. It's possible to use a bundle for other purposes (e.g. a document can be accepted as a transaction). This is primarily defined so that there can be specific rules for some of the bundle types. Binding: bundle-type (required, Indicates the purpose of a bundle - how it is intended to be used.); (xsd)type:code>
< The date/time that the bundle was assembled - i.e. when the resources were placed in the bundle. For many bundles, the timestamp is equal to .meta.lastUpdated, because they are not stored (e.g. search results). When a bundle is placed in a persistent store, .meta.lastUpdated will be usually be changed by the server. When the bundle is a message, a middleware agent altering the message (even if not stored) SHOULD update .meta.lastUpdated. .timestamp is used to track the original time of the Bundle, and SHOULD be populated.
Usage:
* document : the date the document was created. Note: the composition may predate the document, or be associated with multiple documents. The date of the composition - the authoring time - may be earlier than the document assembly time
* message : the date that the content of the message was assembled. This date is not changed by middleware engines unless they add additional data that changes the meaning of the time of the message
* history : the date that the history was assembled. This time would be used as the _since time to ask for subsequent updates
* searchset : the time that the search set was assembled. Note that different pages MAY have different timestamps but need not. Having different timestamps does not imply that subsequent pages will represent or include changes made since the initial query
* transaction | transaction-response | batch | batch-response | collection : no particular assigned meaning
The timestamp value should be greater than the lastUpdated and other timestamps in the resources in the bundle, and it should be equal or earlier than the .meta.lastUpdated on the Bundle itself.; (xsd)timestamp:instant>?
< If a set of search matches, this is the (potentially estimated) total number of entries of type 'match' across all pages in the search. It does not include search.mode = 'include' or 'outcome' entries and it does not provide a count of the number of entries in the Bundle. Only used if the bundle is a search result set. The total does not include resources such as OperationOutcome and included resources, only the total number of matching resources.; (xsd)total:unsignedInt>{0,0}
[]< A series of links that provide context to this bundle. Both Bundle.link and Bundle.entry.link are defined to support providing additional context when Bundles are used (e.g. [HATEOAS](http://en.wikipedia.org/wiki/HATEOAS)).
Bundle.entry.link corresponds to links found in the HTTP header if the resource in the entry was [read](http.html#read) directly.
This specification defines some specific uses of Bundle.link for [searching](search.html#conformance) and [paging](http.html#paging), but no specific uses for Bundle.entry.link, and no defined function in a transaction - the meaning is implementation specific. The behavior of navigation link types (next/prev/first/last) are well defined for searchset and history Bundles but are not currently defined for other types. Implementers who choose to use such link relationships for other bundle types will need to negotiate behavior with their interoperability partners.; (xsd)link:subscription-notification-bundle.link>*
[]< An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).; (xsd)entry:subscription-notification-bundle.entry>+
< Digital Signature - base64 encoded. XML-DSig or a JWS. The signature could be created by the "author" of the bundle or by the originating device. Requirements around inclusion of a signature, verification of signatures and treatment of signed/non-signed bundles is implementation-environment specific.; (xsd)signature:Signature>?
< Captures issues and warnings that relate to the construction of the Bundle and the content within it. Usage notes: These issues and warnings must apply to the Bundle as a whole, not to individual entries.Messages relating to the processing of individual entries (e.g. in a batch or transaction) SHALL be reported in the entry.response.outcome for that entry. If there are errors that arise in the creation of the Bundle, then that should be handled by an OperationOutcome being returned instead of the Bundle.; (xsd)issues:OperationOutcome>?
< An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).; (xsd)first:subscription-notification-bundle.first>
[]< An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).; (xsd)other:subscription-notification-bundle.other>*🔗 An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).subscription-notification-bundle.entry(xsd)(doc)=
<#base:Bundle.entry>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< A series of links that provide context to this entry.; (xsd)link:Bundle.link>*
< The Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when:
* invoking a create
* invoking or responding to an operation where the body is not a single identified resource
* invoking or returning the results of a search or history operation. fullUrl might not be [unique in the context of a resource](bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](references.html), the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the [regex](references.html#regex), then the 'id' portion of the fullUrl SHALL end with the Resource.id.
Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).; (xsd)fullUrl:uri>?
< The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. This is allowed to be a Parameters resource if and only if it is referenced by something else within the Bundle that provides context/meaning.; (xsd)resource:Resource>?
< Information about the search process that lead to the creation of this entry.; (xsd)search:subscription-notification-bundle.entry.search>?
< Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.; (xsd)request:subscription-notification-bundle.entry.request>?
< Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.; (xsd)response:subscription-notification-bundle.entry.response>?🔗 Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.subscription-notification-bundle.entry.request(xsd)(doc)=
<#base:Bundle.entry.request>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred. Binding: http-verb (required, HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details.); (xsd)method:code>
< The URL for this entry, relative to the root (the address to which the request is posted). E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]".; (xsd)url:uri>
< If the ETag values match, return a 304 Not Modified status. See the API documentation for ["Conditional Read"](http.html#cread).; (xsd)ifNoneMatch:string>?
< Only perform the operation if the last updated date matches. See the API documentation for ["Conditional Read"](http.html#cread).; (xsd)ifModifiedSince:instant>?
< Only perform the operation if the Etag value matches. For more information, see the API section ["Managing Resource Contention"](http.html#concurrency).; (xsd)ifMatch:string>?
< Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for ["Conditional Create"](http.html#ccreate). This is just the query portion of the URL - what follows the "?" (not including the "?").; (xsd)ifNoneExist:string>?🔗 Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.subscription-notification-bundle.entry.response(xsd)(doc)=
<#base:Bundle.entry.response>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.; (xsd)status:string>
< The location header created by processing this operation, populated if the operation returns a location.; (xsd)location:uri>?
< The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)). Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.; (xsd)etag:string>?
< The date/time that the resource was modified on the server. This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.; (xsd)lastModified:instant>?
< An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction. For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.
This outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.; (xsd)outcome:Resource>?🔗 Information about the search process that lead to the creation of this entry.subscription-notification-bundle.entry.search(xsd)(doc)=
<#base:Bundle.entry.search>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence. Binding: search-entry-mode (required, Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.); (xsd)mode:code>?
< When searching, the server's search ranking score for the entry. Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.
See [Patient Match](patient-operation-match.html) for the EMPI search which relates to this element.; (xsd)score:decimal>?🔗 An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).subscription-notification-bundle.first(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< A series of links that provide context to this entry.; (xsd)link:Bundle.link>*
< The Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when:
* invoking a create
* invoking or responding to an operation where the body is not a single identified resource
* invoking or returning the results of a search or history operation. fullUrl might not be [unique in the context of a resource](bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](references.html), the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the [regex](references.html#regex), then the 'id' portion of the fullUrl SHALL end with the Resource.id.
Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).; (xsd)fullUrl:uri>
< The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. This is allowed to be a Parameters resource if and only if it is referenced by something else within the Bundle that provides context/meaning.; (xsd)resource:SubscriptionStatus>
< Information about the search process that lead to the creation of this entry.; (xsd)search:subscription-notification-bundle.first.search>{0,0}
< Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.; (xsd)request:subscription-notification-bundle.first.request>?
< Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.; (xsd)response:subscription-notification-bundle.first.response>{0,0}🔗 Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.subscription-notification-bundle.first.request(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred. Binding: http-verb (required, HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details.); (xsd)method:code>
< The URL for this entry, relative to the root (the address to which the request is posted). E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]".; (xsd)url:uri>
< If the ETag values match, return a 304 Not Modified status. See the API documentation for ["Conditional Read"](http.html#cread).; (xsd)ifNoneMatch:string>?
< Only perform the operation if the last updated date matches. See the API documentation for ["Conditional Read"](http.html#cread).; (xsd)ifModifiedSince:instant>?
< Only perform the operation if the Etag value matches. For more information, see the API section ["Managing Resource Contention"](http.html#concurrency).; (xsd)ifMatch:string>?
< Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for ["Conditional Create"](http.html#ccreate). This is just the query portion of the URL - what follows the "?" (not including the "?").; (xsd)ifNoneExist:string>?🔗 Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.subscription-notification-bundle.first.response(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.; (xsd)status:string>
< The location header created by processing this operation, populated if the operation returns a location.; (xsd)location:uri>?
< The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)). Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.; (xsd)etag:string>?
< The date/time that the resource was modified on the server. This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.; (xsd)lastModified:instant>?
< An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction. For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.
This outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.; (xsd)outcome:Resource>?🔗 Information about the search process that lead to the creation of this entry.subscription-notification-bundle.first.search(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence. Binding: search-entry-mode (required, Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.); (xsd)mode:code>?
< When searching, the server's search ranking score for the entry. Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.
See [Patient Match](patient-operation-match.html) for the EMPI search which relates to this element.; (xsd)score:decimal>?🔗 A series of links that provide context to this bundle. Both Bundle.link and Bundle.entry.link are defined to support providing additional context when Bundles are used (e.g. [HATEOAS](http://en.wikipedia.org/wiki/HATEOAS)).
Bundle.entry.link corresponds to links found in the HTTP header if the resource in the entry was [read](http.html#read) directly.
This specification defines some specific uses of Bundle.link for [searching](search.html#conformance) and [paging](http.html#paging), but no specific uses for Bundle.entry.link, and no defined function in a transaction - the meaning is implementation specific. The behavior of navigation link types (next/prev/first/last) are well defined for searchset and history Bundles but are not currently defined for other types. Implementers who choose to use such link relationships for other bundle types will need to negotiate behavior with their interoperability partners.subscription-notification-bundle.link(xsd)(doc)=
<#base:Bundle.link>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A name which details the functional use for this link - see [http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1](http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1). Binding: iana-link-relations (required, ); (xsd)relation:code>
< The reference details for the link.; (xsd)url:uri>🔗 An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).subscription-notification-bundle.other(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< A series of links that provide context to this entry.; (xsd)link:Bundle.link>*
< The Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when:
* invoking a create
* invoking or responding to an operation where the body is not a single identified resource
* invoking or returning the results of a search or history operation. fullUrl might not be [unique in the context of a resource](bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](references.html), the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the [regex](references.html#regex), then the 'id' portion of the fullUrl SHALL end with the Resource.id.
Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).; (xsd)fullUrl:uri>
< The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. This is allowed to be a Parameters resource if and only if it is referenced by something else within the Bundle that provides context/meaning.; (xsd)resource:Resource>?
< Information about the search process that lead to the creation of this entry.; (xsd)search:subscription-notification-bundle.other.search>{0,0}
< Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.; (xsd)request:subscription-notification-bundle.other.request>?
< Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.; (xsd)response:subscription-notification-bundle.other.response>{0,0}🔗 Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.subscription-notification-bundle.other.request(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred. Binding: http-verb (required, HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details.); (xsd)method:code>
< The URL for this entry, relative to the root (the address to which the request is posted). E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]".; (xsd)url:uri>
< If the ETag values match, return a 304 Not Modified status. See the API documentation for ["Conditional Read"](http.html#cread).; (xsd)ifNoneMatch:string>?
< Only perform the operation if the last updated date matches. See the API documentation for ["Conditional Read"](http.html#cread).; (xsd)ifModifiedSince:instant>?
< Only perform the operation if the Etag value matches. For more information, see the API section ["Managing Resource Contention"](http.html#concurrency).; (xsd)ifMatch:string>?
< Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for ["Conditional Create"](http.html#ccreate). This is just the query portion of the URL - what follows the "?" (not including the "?").; (xsd)ifNoneExist:string>?🔗 Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.subscription-notification-bundle.other.response(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.; (xsd)status:string>
< The location header created by processing this operation, populated if the operation returns a location.; (xsd)location:uri>?
< The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)). Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.; (xsd)etag:string>?
< The date/time that the resource was modified on the server. This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.; (xsd)lastModified:instant>?
< An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction. For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.
This outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.; (xsd)outcome:Resource>?🔗 Information about the search process that lead to the creation of this entry.subscription-notification-bundle.other.search(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence. Binding: search-entry-mode (required, Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.); (xsd)mode:code>?
< When searching, the server's search ranking score for the entry. Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.
See [Patient Match](patient-operation-match.html) for the EMPI search which relates to this element.; (xsd)score:decimal>?🔗 The SubscriptionStatus resource describes the state of a Subscription during notifications.SubscriptionStatus(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< The status of the subscription, which marks the server state for managing the subscription. Binding: subscription-status (required, The status of a subscription at the time this notification was generated.); (xsd)status:code>?
< The type of event being conveyed with this notification. Binding: subscription-notification-type (required, The type of notification represented by the status message.); (xsd)type:code>
< The total number of actual events which have been generated since the Subscription was created (inclusive of this notification) - regardless of how many have been successfully communicated. This number is NOT incremented for handshake and heartbeat notifications.; (xsd)eventsSinceSubscriptionStart:integer64>?
[]< Detailed information about events relevant to this subscription notification.; (xsd)notificationEvent:SubscriptionStatus.notificationEvent>*
< The reference to the Subscription which generated this notification.; (xsd)subscription:Subscription*>
< The reference to the SubscriptionTopic for the Subscription which generated this notification. This value SHOULD NOT be present when using `empty` payloads, MAY be present when using `id-only` payloads, and SHOULD be present when using `full-resource` payloads.; (xsd)topic:SubscriptionTopic*>?
[]< A record of errors that occurred when the server processed a notification. Recommended practice: clear errors when status is updated. Binding: subscription-error (example, Codes to represent subscription error details.); (xsd)error:CodeableConcept>*🔗 Detailed information about events relevant to this subscription notification.SubscriptionStatus.notificationEvent(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Either the sequential number of this event in this subscription context or a relative event number for this notification. In subscriptions where delivery of notifications IS NOT guaranteed (e.g., REST-Hook), this number is a unique and monotonically-increasing event number for a subscription. In channels where delivery of notifications IS guaranteed, this number is a relative index for the events present in the notification (e.g., 1, 2, etc.).; (xsd)eventNumber:integer64>
< The actual time this event occurred on the server.; (xsd)timestamp:instant>?
< The focus of this event. While this will usually be a reference to the focus resource of the event, it MAY contain a reference to a non-FHIR object.; (xsd)focus:Resource*>?
[]< Additional context information for this event. Generally, this will contain references to additional resources included with the event (e.g., the Patient relevant to an Encounter), however it MAY refer to non-FHIR objects.; (xsd)additionalContext:Resource*>*🔗 Describes a stream of resource state changes or events and annotated with labels useful to filter projections from this topic.SubscriptionTopic(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< An absolute URI that is used to identify this subscription topic when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this subscription topic is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the subscription topic is stored on different servers. Can be a `urn:uuid:` or a `urn:oid:` but real `http/s:` addresses are preferred. Multiple instances may share the same URL if they have a distinct version.
The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions).
In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.
When this is a locally defined topic or derived from a topic defined in the FHIR spec or an IG, this uniquely identifies the topic and functionality. Ideally this URL resolves to documentation about the use cases.
When this is a topic derived from another topic (e.g., it adds additional filters or functionality to a topic defined in an IG), then this URL should be different than the base and the `derivedFromCanonical` should be filled out with the unique uri as defined in the IG.
When this is a direct implementation from another IG or registered topic (with no additional filters, etc., so not derived), then this url is the unique url for this topic as defined by the IG.; (xsd)url:uri>
[]< Business identifiers assigned to this subscription topic by the performer and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server. Note: This is a business identifier, not a resource identifier (see [discussion](resource.html#identifiers)). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.; (xsd)identifier:Identifier>*
< The identifier that is used to identify this version of the subscription topic when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the Topic author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions are orderable. There may be multiple different instances of a subscription topic that have the same identifier but different versions.; (xsd)version:string>?
< Indicates the mechanism used to compare versions to determine which is more current. If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined. Binding: version-algorithm (extensible, ); (xsd)versionAlgorithm:(<Coding>
|<string>)>?
< A natural language name identifying the subscription topic This name should be usable as an identifier for the module by machine processing applications such as code generation. The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.; (xsd)name:string>?
< A short, descriptive, user-friendly title for the subscription topic. For example, "admission". This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.; (xsd)title:string>?
[]< The canonical URL pointing to another FHIR-defined SubscriptionTopic that is adhered to in whole or in part by this SubscriptionTopic.; (xsd)derivedFrom:SubscriptionTopic*>*
< The current state of the SubscriptionTopic. A nominal state-transition diagram can be found in the [Definition pattern](definition.html#statemachine) documentation
Unknown does not represent "other" - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization). Binding: publication-status (required, The lifecycle status of an artifact.); (xsd)status:code>
< A flag to indicate that this TopSubscriptionTopicic is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage. Allows filtering of SubscriptionTopic that are appropriate for use vs. not.; (xsd)experimental:boolean>?
< The date (and optionally time) when the subscription topic was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the subscription topic changes. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)date:dateTime>?
< Helps establish the "authority/credibility" of the SubscriptionTopic. May also allow for contact.; (xsd)publisher:string>?
[]< Contact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)contact:ContactDetail>*
< A free text natural language description of the Topic from the consumer's perspective. This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the module as conveyed in the text field of the resource itself. This item SHOULD be populated unless the information is available from context.; (xsd)description:markdown>?
[]< The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of code system definitions. When multiple usageContexts are specified, there is no expectation for whether all or any of the contexts apply.; (xsd)useContext:UsageContext>*
[]< A jurisdiction in which the Topic is intended to be used. DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.) Binding: jurisdiction (extensible, Countries and regions within which this artifact is targeted for use.); (xsd)jurisdiction:CodeableConcept>*
< Explains why this Topic is needed and why it has been designed as it has. This element does not describe the usage of the Topic. Rather it is for traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this Topic.; (xsd)purpose:markdown>?
< A copyright statement relating to the SubscriptionTopic and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the SubscriptionTopic. ...; (xsd)copyright:markdown>?
< A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved'). The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.; (xsd)copyrightLabel:string>?
< The date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usage. The date may be more recent than the approval date because of minor changes / editorial corrections.; (xsd)approvalDate:date>?
< The date on which the asset content was last reviewed. Review happens periodically after that, but doesn't change the original approval date. If specified, this is usually after the approval date.; (xsd)lastReviewDate:date>?
< The period during which the SubscriptionTopic content was or is planned to be effective. The effective period for a SubscriptionTopic determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 would be published in 2015.; (xsd)effectivePeriod:Period>?
[]< A definition of a resource-based event that triggers a notification based on the SubscriptionTopic. The criteria may be just a human readable description and/or a full FHIR search string or FHIRPath expression. Multiple triggers are considered OR joined (e.g., a resource update matching ANY of the definitions will trigger a notification).; (xsd)resourceTrigger:SubscriptionTopic.resourceTrigger>*
[]< Event definition which can be used to trigger the SubscriptionTopic.; (xsd)eventTrigger:SubscriptionTopic.eventTrigger>*
[]< List of properties by which Subscriptions on the SubscriptionTopic can be filtered. May be defined Search Parameters (e.g., Encounter.patient) or parameters defined within this SubscriptionTopic context (e.g., hub.event).; (xsd)canFilterBy:SubscriptionTopic.canFilterBy>*
[]< List of properties to describe the shape (e.g., resources) included in notifications from this Subscription Topic.; (xsd)notificationShape:SubscriptionTopic.notificationShape>*🔗 List of properties by which Subscriptions on the SubscriptionTopic can be filtered. May be defined Search Parameters (e.g., Encounter.patient) or parameters defined within this SubscriptionTopic context (e.g., hub.event).SubscriptionTopic.canFilterBy(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Description of how this filtering parameter is intended to be used.; (xsd)description:markdown>?
< URL of the Resource that is the type used in this filter. This is the "focus" of the topic (or one of them if there are more than one). It will be the same, a generality, or a specificity of SubscriptionTopic.resourceTrigger.resource or SubscriptionTopic.eventTrigger.resource when they are present. URL of the Resource that is the type used in this filter. Relative URLs are relative to the StructureDefinition root of the implemented FHIR version (e.g., http://hl7.org/fhir/StructureDefinition). For example, "Patient" maps to http://hl7.org/fhir/StructureDefinition/Patient. For more information, see ElementDefinition.type.code. Binding: subscription-types (extensible, A type of resource, or a Reference (from all versions)); (xsd)resource:uri>?
< Either the canonical URL to a search parameter (like "http://hl7.org/fhir/SearchParameter/encounter-patient") or topic-defined parameter (like "hub.event") which is a label for the filter. Chained parameters are allowed (like "patient.gender") - but can not use colons or modifiers.; (xsd)filterParameter:string>
< Either the canonical URL to a search parameter (like "http://hl7.org/fhir/SearchParameter/encounter-patient") or the officially-defined URI for a shared filter concept (like "http://example.org/concepts/shared-common-event"). Chained parameters are allowed (like "patient.gender") - but can not use colons or modifiers.; (xsd)filterDefinition:uri>?
[]< Comparators allowed for the filter parameter. If no comparators are listed, clients should not expect servers to support any comparators. Binding: search-comparator (required, Search Comparator Codes supported in this filter.); (xsd)comparator:code>*
[]< Modifiers allowed for the filter parameter. If no modifiers are listed, clients should not expect servers to support any modifiers. Binding: search-modifier-code (required, Search Modifier Codes supported in this filter.); (xsd)modifier:code>*🔗 Event definition which can be used to trigger the SubscriptionTopic.SubscriptionTopic.eventTrigger(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The human readable description of an event to trigger a notification for the SubscriptionTopic - for example, "Patient Admission, as defined in HL7v2 via message ADT^A01". Multiple values are considered OR joined (e.g., matching any single event listed). Implementation of particular subscription topics might not use a computable definition and instead base their design on the definition.; (xsd)description:markdown>?
< A well-defined event which can be used to trigger notifications from the SubscriptionTopic. Binding: http://terminology.hl7.org/ValueSet/v2-0003 (example, FHIR Value set/code system definition for HL7 V2 table 0003 (EVENT TYPE CODE).); (xsd)event:CodeableConcept>
< URL of the Resource that is the focus type used in this event trigger. Relative URLs are relative to the StructureDefinition root of the implemented FHIR version (e.g., http://hl7.org/fhir/StructureDefinition). For example, "Patient" maps to http://hl7.org/fhir/StructureDefinition/Patient. For more information, see ElementDefinition.type.code. Binding: subscription-types (extensible, A type of resource, or a Reference (from all versions)); (xsd)resource:uri>🔗 List of properties to describe the shape (e.g., resources) included in notifications from this Subscription Topic.SubscriptionTopic.notificationShape(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< URL of the Resource that is the type used in this shape. This is the 'focus' resource of the topic (or one of them if there are more than one) and the root resource for this shape definition. It will be the same, a generality, or a specificity of SubscriptionTopic.resourceTrigger.resource or SubscriptionTopic.eventTrigger.resource when they are present. URL of the Resource that is the type used in this shape. Relative URLs are relative to the StructureDefinition root of the implemented FHIR version (e.g., http://hl7.org/fhir/StructureDefinition). For example, 'Patient' maps to http://hl7.org/fhir/StructureDefinition/Patient. For more information, see ElementDefinition.type.code. Binding: subscription-types (extensible, A type of resource, or a Reference (from all versions)); (xsd)resource:uri>
[]< Search-style _include directives, rooted in the resource for this shape. Servers SHOULD include resources listed here, if they exist and the user is authorized to receive them. Clients SHOULD be prepared to receive these additional resources, but SHALL function properly without them.; (xsd)include:string>*
[]< Search-style _revinclude directives, rooted in the resource for this shape. Servers SHOULD include resources listed here, if they exist and the user is authorized to receive them. Clients SHOULD be prepared to receive these additional resources, but SHALL function properly without them.; (xsd)revInclude:string>*🔗 A definition of a resource-based event that triggers a notification based on the SubscriptionTopic. The criteria may be just a human readable description and/or a full FHIR search string or FHIRPath expression. Multiple triggers are considered OR joined (e.g., a resource update matching ANY of the definitions will trigger a notification).SubscriptionTopic.resourceTrigger(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The human readable description of this resource trigger for the SubscriptionTopic - for example, "An Encounter enters the 'in-progress' state". Implementation of particular subscription topics might not use a computable definition and instead base their design on the definition.; (xsd)description:markdown>?
< URL of the Resource that is the type used in this resource trigger. Relative URLs are relative to the StructureDefinition root of the implemented FHIR version (e.g., http://hl7.org/fhir/StructureDefinition). For example, "Patient" maps to http://hl7.org/fhir/StructureDefinition/Patient. For more information, see ElementDefinition.type.code. Binding: subscription-types (extensible, A type of resource, or a Reference (from all versions)); (xsd)resource:uri>
[]< The FHIR RESTful interaction which can be used to trigger a notification for the SubscriptionTopic. Multiple values are considered OR joined (e.g., CREATE or UPDATE). If not present, all supported interactions are assumed. Binding: interaction-trigger (required, FHIR RESTful interaction used to filter a resource-based SubscriptionTopic trigger.); (xsd)supportedInteraction:code>*
< The FHIR query based rules that the server should use to determine when to trigger a notification for this subscription topic.; (xsd)queryCriteria:SubscriptionTopic.resourceTrigger.queryCriteria>?
< The FHIRPath based rules that the server should use to determine when to trigger a notification for this topic. FHIRPath expression with %previous and %current vars.; (xsd)fhirPathCriteria:string>?🔗 The FHIR query based rules that the server should use to determine when to trigger a notification for this subscription topic.SubscriptionTopic.resourceTrigger.queryCriteria(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The FHIR query based rules are applied to the previous resource state (e.g., state before an update). The rules are search criteria (without the [base] part). Like Bundle.entry.request.url, it has no leading slash character (`/`).; (xsd)previous:string>?
< For `create` interactions, should the `previous` criteria count as an automatic pass or an automatic fail. If not present, the testing behavior during `create` interactions is unspecified (server discretion). Binding: subscriptiontopic-cr-behavior (required, Behavior a server can exhibit when a criteria state does not exist (e.g., state prior to a create or after a delete).); (xsd)resultForCreate:code>?
< The FHIR query based rules are applied to the current resource state (e.g., state after an update). The rules are search criteria (without the [base] part). Like Bundle.entry.request.url, it has no leading slash character (`/`).; (xsd)current:string>?
< For 'delete' interactions, should the 'current' query criteria count as an automatic pass or an automatic fail. If not present, the testing behavior during `delete` interactions is unspecified (server discretion). Binding: subscriptiontopic-cr-behavior (required, Behavior a server can exhibit when a criteria state does not exist (e.g., state prior to a create or after a delete).); (xsd)resultForDelete:code>?
< If set to `true`, both the `current` and `previous` query criteria must evaluate `true` to trigger a notification for this topic. If set to `false` or not present, a notification for this topic will be triggered if either the `current` or `previous` tests evaluate to `true`. Please note the interaction between this element and the `resultForCreate`/`resultForDelete` elements during `create` and `delete` interactions. For example, if `resultForCreate` is set to `test-passes`, setting `requireBoth` to `false` means that every `create` will trigger a notification while setting `requireBoth` to `true` will result in notifications if the `current` test passes. Similarly, if `resultForCreate` is set to `test-fails`, setting `requireBoth` to `true` means that no `create` will be able to generate a notification while setting `requireBoth` to `false` will result in notifications if the `current` test passes.; (xsd)requireBoth:boolean>?🔗 A homogeneous material with a definite composition.Substance(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< Unique identifier for the substance. For an instance, an identifier associated with the package/container (usually a label affixed directly).; (xsd)identifier:Identifier>*
< A boolean to indicate if this an instance of a substance or a kind of one (a definition).; (xsd)instance:boolean>
< A code to indicate if the substance is actively used. Binding: substance-status (required, A code to indicate if the substance is actively used.); (xsd)status:code>?
[]< A code that classifies the general type of substance. This is used for searching, sorting and display purposes. The level of granularity is defined by the category concepts in the value set. More fine-grained filtering can be performed using the metadata and/or terminology hierarchy in Substance.code. Binding: substance-category (extensible, Category or classification of substance.); (xsd)category:CodeableConcept>*
< A code (or set of codes) that identify this substance. This could be a reference to an externally defined code. It could also be a locally assigned code (e.g. a formulary), optionally with translations to the standard drug codes. Binding: substance-code (example, Substance codes.); (xsd)code:SubstanceDefinition*>
< A description of the substance - its appearance, handling requirements, and other usage notes.; (xsd)description:markdown>?
< When the substance is no longer valid to use. For some substances, a single arbitrary date is used for expiry.; (xsd)expiry:dateTime>?
< The amount of the substance.; (xsd)quantity:SimpleQuantity>?
[]< A substance can be composed of other substances.; (xsd)ingredient:Substance.ingredient>*🔗 A substance can be composed of other substances.Substance.ingredient(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The amount of the ingredient in the substance - a concentration ratio.; (xsd)quantity:Ratio>?
< Another substance that is a component of this substance. Binding: substance-code (example, Substance Ingredient codes.); (xsd)substance:(<CodeableConcept>
|<Substance>)>🔗 The detailed description of a substance, typically at a level beyond what is used for prescribing.SubstanceDefinition(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< Identifier by which this substance is known.; (xsd)identifier:Identifier>*
< A business level version identifier of the substance.; (xsd)version:string>?
< Status of substance within the catalogue e.g. active, retired. Binding: publication-status (preferred, The lifecycle status of an artifact.); (xsd)status:CodeableConcept>?
[]< A high level categorization, e.g. polymer or nucleic acid, or food, chemical, biological, or a lower level such as the general types of polymer (linear or branch chain) or type of impurity (process related or contaminant).; (xsd)classification:CodeableConcept>*
< If the substance applies to human or veterinary use. Binding: medicinal-product-domain (example, Applicable domain for this product (e.g. human, veterinary).); (xsd)domain:CodeableConcept>?
[]< The quality standard, established benchmark, to which substance complies (e.g. USP/NF, Ph. Eur, JP, BP, Company Standard). Binding: substance-grade (example, The quality standard, established benchmark, to which a substance complies); (xsd)grade:CodeableConcept>*
< Textual description of the substance.; (xsd)description:markdown>?
[]< Supporting literature.; (xsd)informationSource:Citation*>*
[]< Textual comment about the substance's catalogue or registry record.; (xsd)note:Annotation>*
[]< The entity that creates, makes, produces or fabricates the substance. This is a set of potential manufacturers but is not necessarily comprehensive.; (xsd)manufacturer:Organization*>*
[]< An entity that is the source for the substance. It may be different from the manufacturer. Supplier is synonymous to a distributor.; (xsd)supplier:Organization*>*
[]< Moiety, for structural modifications.; (xsd)moiety:SubstanceDefinition.moiety>*
[]< General specifications for this substance.; (xsd)characterization:SubstanceDefinition.characterization>*
[]< General specifications for this substance.; (xsd)property:SubstanceDefinition.property>*
< General information detailing this substance.; (xsd)referenceInformation:SubstanceReferenceInformation*>?
[]< The average mass of a molecule of a compound compared to 1/12 the mass of carbon 12 and calculated as the sum of the atomic weights of the constituent atoms.; (xsd)molecularWeight:SubstanceDefinition.molecularWeight>*
< Structural information.; (xsd)structure:SubstanceDefinition.structure>?
[]< Codes associated with the substance.; (xsd)code:SubstanceDefinition.code>*
[]< Names applicable to this substance.; (xsd)name:SubstanceDefinition.name>*
[]< A link between this substance and another, with details of the relationship.; (xsd)relationship:SubstanceDefinition.relationship>*
< Data items specific to nucleic acids.; (xsd)nucleicAcid:SubstanceNucleicAcid*>?
< Data items specific to polymers.; (xsd)polymer:SubstancePolymer*>?
< Data items specific to proteins.; (xsd)protein:SubstanceProtein*>?
< Material or taxonomic/anatomical source for the substance.; (xsd)sourceMaterial:SubstanceDefinition.sourceMaterial>?🔗 Codes associated with the substance.SubstanceDefinition.code(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The specific code.; (xsd)code:CodeableConcept>?
< Status of the code assignment, for example 'provisional', 'approved'. Binding: publication-status (preferred, The lifecycle status of an artifact.); (xsd)status:CodeableConcept>?
< The date at which the code status was changed as part of the terminology maintenance.; (xsd)statusDate:dateTime>?
[]< Any comment can be provided in this field, if necessary.; (xsd)note:Annotation>*
[]< Supporting literature.; (xsd)source:DocumentReference*>*🔗 General specifications for this substance.SubstanceDefinition.characterization(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The method used to elucidate the characterization of the drug substance. Example: HPLC. Binding: substance-structure-technique (example, The method used to elucidate the characterization of the drug substance.); (xsd)technique:CodeableConcept>?
< Describes the nature of the chemical entity and explains, for instance, whether this is a base or a salt form. Binding: substance-form (example, ); (xsd)form:CodeableConcept>?
< The description or justification in support of the interpretation of the data file.; (xsd)description:markdown>?
[]< The data produced by the analytical instrument or a pictorial representation of that data. Examples: a JCAMP, JDX, or ADX file, or a chromatogram or spectrum analysis.; (xsd)file:Attachment>*🔗 Moiety, for structural modifications.SubstanceDefinition.moiety(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Role that the moiety is playing.; (xsd)role:CodeableConcept>?
< Identifier by which this moiety substance is known.; (xsd)identifier:Identifier>?
< Textual name for this moiety substance.; (xsd)name:string>?
< Stereochemistry type. Binding: substance-stereochemistry (example, The optical rotation type of a substance.); (xsd)stereochemistry:CodeableConcept>?
< Optical activity type. Binding: substance-optical-activity (example, The optical rotation type of a substance.); (xsd)opticalActivity:CodeableConcept>?
< Molecular formula for this moiety of this substance, typically using the Hill system.; (xsd)molecularFormula:string>?
< Quantitative value for this moiety.; (xsd)amount:(<Quantity>
|<string>)>?
< The measurement type of the quantitative value. In capturing the actual relative amounts of substances or molecular fragments it may be necessary to indicate whether the amount refers to, for example, a mole ratio or weight ratio. Binding: substance-amount-type (example, The relationship between two substance types.); (xsd)measurementType:CodeableConcept>?🔗 The average mass of a molecule of a compound compared to 1/12 the mass of carbon 12 and calculated as the sum of the atomic weights of the constituent atoms.SubstanceDefinition.molecularWeight(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The method by which the molecular weight was determined. Binding: substance-weight-method (example, The method by which the substance weight was measured.); (xsd)method:CodeableConcept>?
< Type of molecular weight such as exact, average (also known as. number average), weight average. Binding: substance-weight-type (example, The type of substance weight measurement.); (xsd)type:CodeableConcept>?
< 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.; (xsd)amount:Quantity>🔗 Names applicable to this substance.SubstanceDefinition.name(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The actual name.; (xsd)name:string>
< Name type, for example 'systematic', 'scientific, 'brand'. Binding: substance-name-type (example, The type of a name given to a substance.); (xsd)type:CodeableConcept>?
< The status of the name, for example 'current', 'proposed'. Binding: publication-status (preferred, The lifecycle status of an artifact.); (xsd)status:CodeableConcept>?
< If this is the preferred name for this substance.; (xsd)preferred:boolean>?
[]< Human language that the name is written in. Binding: all-languages (required, IETF language tag for a human language); (xsd)language:CodeableConcept>*
[]< The use context of this name for example if there is a different name a drug active ingredient as opposed to a food colour additive. Binding: substance-name-domain (example, The use context of a substance name for example if there is a different name when used as a drug active ingredient as opposed to a food colour additive.); (xsd)domain:CodeableConcept>*
[]< The jurisdiction where this name applies. Binding: jurisdiction (example, Jurisdiction codes); (xsd)jurisdiction:CodeableConcept>*
[]< A synonym of this particular name, by which the substance is also known.; (xsd)synonym:SubstanceDefinition.name>*
[]< A translation for this name into another human language.; (xsd)translation:SubstanceDefinition.name>*
[]< Details of the official nature of this name.; (xsd)official:SubstanceDefinition.name.official>*
[]< Supporting literature.; (xsd)source:DocumentReference*>*🔗 Details of the official nature of this name.SubstanceDefinition.name.official(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Which authority uses this official name. Binding: substance-name-authority (preferred, An authority that officates substance names.); (xsd)authority:CodeableConcept>?
< The status of the official name, for example 'draft', 'active', 'retired'. Binding: publication-status (preferred, The lifecycle status of an artifact.); (xsd)status:CodeableConcept>?
< Date of the official name change.; (xsd)date:dateTime>?🔗 General specifications for this substance.SubstanceDefinition.property(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A code expressing the type of property. Binding: product-characteristic-codes (example, This value set includes all observable entity codes from SNOMED CT - provided as an exemplar value set.); (xsd)type:CodeableConcept>
(<valueAttachment:Attachment>
|<valueBoolean:boolean>
|<valueCodeableConcept:CodeableConcept>
|<valueDate:date>
|<valueQuantity:Quantity>)?🔗 A link between this substance and another, with details of the relationship.SubstanceDefinition.relationship(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A pointer to another substance, as a resource or just a representational code.; (xsd)substanceDefinition:(<CodeableConcept>
|<SubstanceDefinition>)>?
< For example "salt to parent", "active moiety", "starting material", "polymorph", "impurity of". Binding: substance-relationship-type (example, The relationship between two substance types.); (xsd)type:CodeableConcept>
< For example where an enzyme strongly bonds with a particular substance, this is a defining relationship for that enzyme, out of several possible substance relationships.; (xsd)isDefining:boolean>?
< A numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other.; (xsd)amount:(<Quantity>
|<Ratio>
|<string>)>?
< For use when the numeric has an uncertain range.; (xsd)ratioHighLimitAmount:Ratio>?
< An operator for the amount, for example "average", "approximately", "less than". Binding: substance-amount-type (example, The relationship between two substance types.); (xsd)comparator:CodeableConcept>?
[]< Supporting literature.; (xsd)source:DocumentReference*>*🔗 Material or taxonomic/anatomical source for the substance.SubstanceDefinition.sourceMaterial(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A classification that provides the origin of the raw material. Example: cat hair would be an Animal source type. Binding: substance-source-material-type (example, A classification that provides the origin of the substance raw material.); (xsd)type:CodeableConcept>?
< The genus of an organism, typically referring to the Latin epithet of the genus element of the plant/animal scientific name. Binding: substance-source-material-genus (example, The genus of an organism, typically referring to the Latin epithet of the genus element of the plant/animal scientific name.); (xsd)genus:CodeableConcept>?
< The species of an organism, typically referring to the Latin epithet of the species of the plant/animal. Binding: substance-source-material-species (example, A species of origin a substance raw material.); (xsd)species:CodeableConcept>?
< An anatomical origin of the source material within an organism. Binding: substance-source-material-part (example, An anatomical origin of the source material within an organism.); (xsd)part:CodeableConcept>?
[]< The country or countries where the material is harvested. Binding: country (required, Jurisdiction codes); (xsd)countryOfOrigin:CodeableConcept>*🔗 Structural information.SubstanceDefinition.structure(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Stereochemistry type. Binding: substance-stereochemistry (example, The optical rotation type of a substance.); (xsd)stereochemistry:CodeableConcept>?
< Optical activity type. Binding: substance-optical-activity (example, The optical rotation type of a substance.); (xsd)opticalActivity:CodeableConcept>?
< An expression which states the number and type of atoms present in a molecule of a substance.; (xsd)molecularFormula:string>?
< Specified per moiety according to the Hill system, i.e. first C, then H, then alphabetical, each moiety separated by a dot.; (xsd)molecularFormulaByMoiety:string>?
< The molecular weight or weight range (for proteins, polymers or nucleic acids).; (xsd)molecularWeight:SubstanceDefinition.molecularWeight>?
[]< The method used to elucidate the structure of the drug substance. Examples: X-ray, NMR, Peptide mapping, Ligand binding assay. Binding: substance-structure-technique (example, The method used to elucidate the structure of the drug substance.); (xsd)technique:CodeableConcept>*
[]< The source of information about the structure.; (xsd)sourceDocument:DocumentReference*>*
[]< A depiction of the structure of the substance.; (xsd)representation:SubstanceDefinition.structure.representation>*🔗 A depiction of the structure of the substance.SubstanceDefinition.structure.representation(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The kind of structural representation (e.g. full, partial). Binding: substance-representation-type (example, A format of a substance representation.); (xsd)type:CodeableConcept>?
< The structural representation as a text string in a standard format.; (xsd)representation:string>?
< The format of the representation e.g. InChI, SMILES, MOLFILE, CDX, SDF, PDB, mmCIF. The logical content type rather than the physical file format of a document. Binding: substance-representation-format (example, A format of a substance representation.); (xsd)format:CodeableConcept>?
< An attached file with the structural representation e.g. a molecular structure graphic of the substance, a JCAMP or AnIML file.; (xsd)document:DocumentReference*>?🔗 Nucleic acids are defined by three distinct elements: the base, sugar and linkage. Individual substance/moiety IDs will be created for each of these elements. The nucleotide sequence will be always entered in the 5’-3’ direction.SubstanceNucleicAcid(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< The type of the sequence shall be specified based on a controlled vocabulary.; (xsd)sequenceType:CodeableConcept>?
< The number of linear sequences of nucleotides linked through phosphodiester bonds shall be described. Subunits would be strands of nucleic acids that are tightly associated typically through Watson-Crick base pairing. NOTE: If not specified in the reference source, the assumption is that there is 1 subunit.; (xsd)numberOfSubunits:integer>?
< The area of hybridisation shall be described if applicable for double stranded RNA or DNA. The number associated with the subunit followed by the number associated to the residue shall be specified in increasing order. The underscore “” shall be used as separator as follows: “Subunitnumber Residue”.; (xsd)areaOfHybridisation:string>?
< (TBC).; (xsd)oligoNucleotideType:CodeableConcept>?
[]< Subunits are listed in order of decreasing length; sequences of the same length will be ordered by molecular weight; subunits that have identical sequences will be repeated multiple times.; (xsd)subunit:SubstanceNucleicAcid.subunit>*🔗 Subunits are listed in order of decreasing length; sequences of the same length will be ordered by molecular weight; subunits that have identical sequences will be repeated multiple times.SubstanceNucleicAcid.subunit(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Index of linear sequences of nucleic acids in order of decreasing length. Sequences of the same length will be ordered by molecular weight. Subunits that have identical sequences will be repeated and have sequential subscripts.; (xsd)subunit:integer>?
< Actual nucleotide sequence notation from 5' to 3' end using standard single letter codes. In addition to the base sequence, sugar and type of phosphate or non-phosphate linkage should also be captured.; (xsd)sequence:string>?
< The length of the sequence shall be captured.; (xsd)length:integer>?
< (TBC).; (xsd)sequenceAttachment:Attachment>?
< The nucleotide present at the 5’ terminal shall be specified based on a controlled vocabulary. Since the sequence is represented from the 5' to the 3' end, the 5’ prime nucleotide is the letter at the first position in the sequence. A separate representation would be redundant.; (xsd)fivePrime:CodeableConcept>?
< The nucleotide present at the 3’ terminal shall be specified based on a controlled vocabulary. Since the sequence is represented from the 5' to the 3' end, the 5’ prime nucleotide is the letter at the last position in the sequence. A separate representation would be redundant.; (xsd)threePrime:CodeableConcept>?
[]< The linkages between sugar residues will also be captured.; (xsd)linkage:SubstanceNucleicAcid.subunit.linkage>*
[]< 5.3.6.8.1 Sugar ID (Mandatory).; (xsd)sugar:SubstanceNucleicAcid.subunit.sugar>*🔗 The linkages between sugar residues will also be captured.SubstanceNucleicAcid.subunit.linkage(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The entity that links the sugar residues together should also be captured for nearly all naturally occurring nucleic acid the linkage is a phosphate group. For many synthetic oligonucleotides phosphorothioate linkages are often seen. Linkage connectivity is assumed to be 3’-5’. If the linkage is either 3’-3’ or 5’-5’ this should be specified.; (xsd)connectivity:string>?
< Each linkage will be registered as a fragment and have an ID.; (xsd)identifier:Identifier>?
< Each linkage will be registered as a fragment and have at least one name. A single name shall be assigned to each linkage.; (xsd)name:string>?
< Residues shall be captured as described in 5.3.6.8.3.; (xsd)residueSite:string>?🔗 5.3.6.8.1 Sugar ID (Mandatory).SubstanceNucleicAcid.subunit.sugar(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The Substance ID of the sugar or sugar-like component that make up the nucleotide.; (xsd)identifier:Identifier>?
< The name of the sugar or sugar-like component that make up the nucleotide.; (xsd)name:string>?
< The residues that contain a given sugar will be captured. The order of given residues will be captured in the 5‘-3‘direction consistent with the base sequences listed above.; (xsd)residueSite:string>?🔗 Properties of a substance specific to it being a polymer.SubstancePolymer(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< A business idenfier for this polymer, but typically this is handled by a SubstanceDefinition identifier.; (xsd)identifier:Identifier>?
< Overall type of the polymer.; (xsd)class:CodeableConcept>?
< Polymer geometry, e.g. linear, branched, cross-linked, network or dendritic.; (xsd)geometry:CodeableConcept>?
[]< Descrtibes the copolymer sequence type (polymer connectivity).; (xsd)copolymerConnectivity:CodeableConcept>*
< Todo - this is intended to connect to a repeating full modification structure, also used by Protein and Nucleic Acid . String is just a placeholder.; (xsd)modification:string>?
[]< Todo.; (xsd)monomerSet:SubstancePolymer.monomerSet>*
[]< Specifies and quantifies the repeated units and their configuration.; (xsd)repeat:SubstancePolymer.repeat>*🔗 Todo.SubstancePolymer.monomerSet(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Captures the type of ratio to the entire polymer, e.g. Monomer/Polymer ratio, SRU/Polymer Ratio.; (xsd)ratioType:CodeableConcept>?
[]< The starting materials - monomer(s) used in the synthesis of the polymer.; (xsd)startingMaterial:SubstancePolymer.monomerSet.startingMaterial>*🔗 The starting materials - monomer(s) used in the synthesis of the polymer.SubstancePolymer.monomerSet.startingMaterial(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The type of substance for this starting material.; (xsd)code:CodeableConcept>?
< Substance high level category, e.g. chemical substance.; (xsd)category:CodeableConcept>?
< Used to specify whether the attribute described is a defining element for the unique identification of the polymer.; (xsd)isDefining:boolean>?
< A percentage.; (xsd)amount:Quantity>?🔗 Specifies and quantifies the repeated units and their configuration.SubstancePolymer.repeat(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A representation of an (average) molecular formula from a polymer.; (xsd)averageMolecularFormula:string>?
< How the quantitative amount of Structural Repeat Units is captured (e.g. Exact, Numeric, Average).; (xsd)repeatUnitAmountType:CodeableConcept>?
[]< An SRU - Structural Repeat Unit.; (xsd)repeatUnit:SubstancePolymer.repeat.repeatUnit>*🔗 An SRU - Structural Repeat Unit.SubstancePolymer.repeat.repeatUnit(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Structural repeat units are essential elements for defining polymers.; (xsd)unit:string>?
< The orientation of the polymerisation, e.g. head-tail, head-head, random.; (xsd)orientation:CodeableConcept>?
< Number of repeats of this unit.; (xsd)amount:integer>?
[]< Applies to homopolymer and block co-polymers where the degree of polymerisation within a block can be described.; (xsd)degreeOfPolymerisation:SubstancePolymer.repeat.repeatUnit.degreeOfPolymerisation>*
[]< A graphical structure for this SRU.; (xsd)structuralRepresentation:SubstancePolymer.repeat.repeatUnit.structuralRepresentation>*🔗 Applies to homopolymer and block co-polymers where the degree of polymerisation within a block can be described.SubstancePolymer.repeat.repeatUnit.degreeOfPolymerisation(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The type of the degree of polymerisation shall be described, e.g. SRU/Polymer Ratio.; (xsd)type:CodeableConcept>?
< An average amount of polymerisation.; (xsd)average:integer>?
< A low expected limit of the amount.; (xsd)low:integer>?
< A high expected limit of the amount.; (xsd)high:integer>?🔗 A graphical structure for this SRU.SubstancePolymer.repeat.repeatUnit.structuralRepresentation(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The type of structure (e.g. Full, Partial, Representative).; (xsd)type:CodeableConcept>?
< The structural representation as text string in a standard format e.g. InChI, SMILES, MOLFILE, CDX, SDF, PDB, mmCIF.; (xsd)representation:string>?
< The format of the representation e.g. InChI, SMILES, MOLFILE, CDX, SDF, PDB, mmCIF.; (xsd)format:CodeableConcept>?
< An attached file with the structural representation.; (xsd)attachment:Attachment>?🔗 A SubstanceProtein is defined as a single unit of a linear amino acid sequence, or a combination of subunits that are either covalently linked or have a defined invariant stoichiometric relationship. This includes all synthetic, recombinant and purified SubstanceProteins of defined sequence, whether the use is therapeutic or prophylactic. This set of elements will be used to describe albumins, coagulation factors, cytokines, growth factors, peptide/SubstanceProtein hormones, enzymes, toxins, toxoids, recombinant vaccines, and immunomodulators.SubstanceProtein(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< The SubstanceProtein descriptive elements will only be used when a complete or partial amino acid sequence is available or derivable from a nucleic acid sequence.; (xsd)sequenceType:CodeableConcept>?
< Number of linear sequences of amino acids linked through peptide bonds. The number of subunits constituting the SubstanceProtein shall be described. It is possible that the number of subunits can be variable.; (xsd)numberOfSubunits:integer>?
[]< The disulphide bond between two cysteine residues either on the same subunit or on two different subunits shall be described. The position of the disulfide bonds in the SubstanceProtein shall be listed in increasing order of subunit number and position within subunit followed by the abbreviation of the amino acids involved. The disulfide linkage positions shall actually contain the amino acid Cysteine at the respective positions.; (xsd)disulfideLinkage:string>*
[]< This subclause refers to the description of each subunit constituting the SubstanceProtein. A subunit is a linear sequence of amino acids linked through peptide bonds. The Subunit information shall be provided when the finished SubstanceProtein is a complex of multiple sequences; subunits are not used to delineate domains within a single sequence. Subunits are listed in order of decreasing length; sequences of the same length will be ordered by decreasing molecular weight; subunits that have identical sequences will be repeated multiple times.; (xsd)subunit:SubstanceProtein.subunit>*🔗 This subclause refers to the description of each subunit constituting the SubstanceProtein. A subunit is a linear sequence of amino acids linked through peptide bonds. The Subunit information shall be provided when the finished SubstanceProtein is a complex of multiple sequences; subunits are not used to delineate domains within a single sequence. Subunits are listed in order of decreasing length; sequences of the same length will be ordered by decreasing molecular weight; subunits that have identical sequences will be repeated multiple times.SubstanceProtein.subunit(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Index of primary sequences of amino acids linked through peptide bonds in order of decreasing length. Sequences of the same length will be ordered by molecular weight. Subunits that have identical sequences will be repeated and have sequential subscripts.; (xsd)subunit:integer>?
< The sequence information shall be provided enumerating the amino acids from N- to C-terminal end using standard single-letter amino acid codes. Uppercase shall be used for L-amino acids and lowercase for D-amino acids. Transcribed SubstanceProteins will always be described using the translated sequence; for synthetic peptide containing amino acids that are not represented with a single letter code an X should be used within the sequence. The modified amino acids will be distinguished by their position in the sequence.; (xsd)sequence:string>?
< Length of linear sequences of amino acids contained in the subunit.; (xsd)length:integer>?
< The sequence information shall be provided enumerating the amino acids from N- to C-terminal end using standard single-letter amino acid codes. Uppercase shall be used for L-amino acids and lowercase for D-amino acids. Transcribed SubstanceProteins will always be described using the translated sequence; for synthetic peptide containing amino acids that are not represented with a single letter code an X should be used within the sequence. The modified amino acids will be distinguished by their position in the sequence.; (xsd)sequenceAttachment:Attachment>?
< Unique identifier for molecular fragment modification based on the ISO 11238 Substance ID.; (xsd)nTerminalModificationId:Identifier>?
< The name of the fragment modified at the N-terminal of the SubstanceProtein shall be specified.; (xsd)nTerminalModification:string>?
< Unique identifier for molecular fragment modification based on the ISO 11238 Substance ID.; (xsd)cTerminalModificationId:Identifier>?
< The modification at the C-terminal shall be specified.; (xsd)cTerminalModification:string>?🔗 Todo.SubstanceReferenceInformation(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< Todo.; (xsd)comment:string>?
[]< Todo.; (xsd)gene:SubstanceReferenceInformation.gene>*
[]< Todo.; (xsd)geneElement:SubstanceReferenceInformation.geneElement>*
[]< Todo.; (xsd)target:SubstanceReferenceInformation.target>*🔗 Todo.SubstanceReferenceInformation.gene(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Todo.; (xsd)geneSequenceOrigin:CodeableConcept>?
< Todo.; (xsd)gene:CodeableConcept>?
[]< Todo.; (xsd)source:DocumentReference*>*🔗 Todo.SubstanceReferenceInformation.geneElement(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Todo.; (xsd)type:CodeableConcept>?
< Todo.; (xsd)element:Identifier>?
[]< Todo.; (xsd)source:DocumentReference*>*🔗 Todo.SubstanceReferenceInformation.target(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Todo.; (xsd)target:Identifier>?
< Todo.; (xsd)type:CodeableConcept>?
< Todo.; (xsd)interaction:CodeableConcept>?
< Todo.; (xsd)organism:CodeableConcept>?
< Todo.; (xsd)organismType:CodeableConcept>?
< Todo.; (xsd)amount:(<Quantity>
|<Range>
|<string>)>?
< Todo.; (xsd)amountType:CodeableConcept>?
[]< Todo.; (xsd)source:DocumentReference*>*🔗 Source material shall capture information on the taxonomic and anatomical origins as well as the fraction of a material that can result in or can be modified to form a substance. This set of data elements shall be used to define polymer substances isolated from biological matrices. Taxonomic and anatomical origins shall be described using a controlled vocabulary as required. This information is captured for naturally derived polymers ( . starch) and structurally diverse substances. For Organisms belonging to the Kingdom Plantae the Substance level defines the fresh material of a single species or infraspecies, the Herbal Drug and the Herbal preparation. For Herbal preparations, the fraction information will be captured at the Substance information level and additional information for herbal extracts will be captured at the Specified Substance Group 1 information level. See for further explanation the Substance Class: Structurally Diverse and the herbal annex.SubstanceSourceMaterial(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< General high level classification of the source material specific to the origin of the material.; (xsd)sourceMaterialClass:CodeableConcept>?
< The type of the source material shall be specified based on a controlled vocabulary. For vaccines, this subclause refers to the class of infectious agent.; (xsd)sourceMaterialType:CodeableConcept>?
< The state of the source material when extracted.; (xsd)sourceMaterialState:CodeableConcept>?
< The unique identifier associated with the source material parent organism shall be specified.; (xsd)organismId:Identifier>?
< The organism accepted Scientific name shall be provided based on the organism taxonomy.; (xsd)organismName:string>?
[]< The parent of the herbal drug Ginkgo biloba, Leaf is the substance ID of the substance (fresh) of Ginkgo biloba L. or Ginkgo biloba L. (Whole plant).; (xsd)parentSubstanceId:Identifier>*
[]< The parent substance of the Herbal Drug, or Herbal preparation.; (xsd)parentSubstanceName:string>*
[]< The country where the plant material is harvested or the countries where the plasma is sourced from as laid down in accordance with the Plasma Master File. For “Plasma-derived substances” the attribute country of origin provides information about the countries used for the manufacturing of the Cryopoor plama or Crioprecipitate.; (xsd)countryOfOrigin:CodeableConcept>*
[]< The place/region where the plant is harvested or the places/regions where the animal source material has its habitat.; (xsd)geographicalLocation:string>*
< Stage of life for animals, plants, insects and microorganisms. This information shall be provided only when the substance is significantly different in these stages (e.g. foetal bovine serum).; (xsd)developmentStage:CodeableConcept>?
[]< Many complex materials are fractions of parts of plants, animals, or minerals. Fraction elements are often necessary to define both Substances and Specified Group 1 Substances. For substances derived from Plants, fraction information will be captured at the Substance information level ( . Oils, Juices and Exudates). Additional information for Extracts, such as extraction solvent composition, will be captured at the Specified Substance Group 1 information level. For plasma-derived products fraction information will be captured at the Substance and the Specified Substance Group 1 levels.; (xsd)fractionDescription:SubstanceSourceMaterial.fractionDescription>*
< This subclause describes the organism which the substance is derived from. For vaccines, the parent organism shall be specified based on these subclause elements. As an example, full taxonomy will be described for the Substance Name: ., Leaf.; (xsd)organism:SubstanceSourceMaterial.organism>?
[]< To do.; (xsd)partDescription:SubstanceSourceMaterial.partDescription>*🔗 Many complex materials are fractions of parts of plants, animals, or minerals. Fraction elements are often necessary to define both Substances and Specified Group 1 Substances. For substances derived from Plants, fraction information will be captured at the Substance information level ( . Oils, Juices and Exudates). Additional information for Extracts, such as extraction solvent composition, will be captured at the Specified Substance Group 1 information level. For plasma-derived products fraction information will be captured at the Substance and the Specified Substance Group 1 levels.SubstanceSourceMaterial.fractionDescription(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< This element is capturing information about the fraction of a plant part, or human plasma for fractionation.; (xsd)fraction:string>?
< The specific type of the material constituting the component. For Herbal preparations the particulars of the extracts (liquid/dry) is described in Specified Substance Group 1.; (xsd)materialType:CodeableConcept>?🔗 This subclause describes the organism which the substance is derived from. For vaccines, the parent organism shall be specified based on these subclause elements. As an example, full taxonomy will be described for the Substance Name: ., Leaf.SubstanceSourceMaterial.organism(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The family of an organism shall be specified.; (xsd)family:CodeableConcept>?
< The genus of an organism shall be specified; refers to the Latin epithet of the genus element of the plant/animal scientific name; it is present in names for genera, species and infraspecies.; (xsd)genus:CodeableConcept>?
< The species of an organism shall be specified; refers to the Latin epithet of the species of the plant/animal; it is present in names for species and infraspecies.; (xsd)species:CodeableConcept>?
< The Intraspecific type of an organism shall be specified.; (xsd)intraspecificType:CodeableConcept>?
< The intraspecific description of an organism shall be specified based on a controlled vocabulary. For Influenza Vaccine, the intraspecific description shall contain the syntax of the antigen in line with the WHO convention.; (xsd)intraspecificDescription:string>?
[]< 4.9.13.6.1 Author type (Conditional).; (xsd)author:SubstanceSourceMaterial.organism.author>*
< 4.9.13.8.1 Hybrid species maternal organism ID (Optional).; (xsd)hybrid:SubstanceSourceMaterial.organism.hybrid>?
< 4.9.13.7.1 Kingdom (Conditional).; (xsd)organismGeneral:SubstanceSourceMaterial.organism.organismGeneral>?🔗 4.9.13.6.1 Author type (Conditional).SubstanceSourceMaterial.organism.author(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The type of author of an organism species shall be specified. The parenthetical author of an organism species refers to the first author who published the plant/animal name (of any rank). The primary author of an organism species refers to the first author(s), who validly published the plant/animal name.; (xsd)authorType:CodeableConcept>?
< The author of an organism species shall be specified. The author year of an organism shall also be specified when applicable; refers to the year in which the first author(s) published the infraspecific plant/animal name (of any rank).; (xsd)authorDescription:string>?🔗 4.9.13.8.1 Hybrid species maternal organism ID (Optional).SubstanceSourceMaterial.organism.hybrid(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The identifier of the maternal species constituting the hybrid organism shall be specified based on a controlled vocabulary. For plants, the parents aren’t always known, and it is unlikely that it will be known which is maternal and which is paternal.; (xsd)maternalOrganismId:string>?
< The name of the maternal species constituting the hybrid organism shall be specified. For plants, the parents aren’t always known, and it is unlikely that it will be known which is maternal and which is paternal.; (xsd)maternalOrganismName:string>?
< The identifier of the paternal species constituting the hybrid organism shall be specified based on a controlled vocabulary.; (xsd)paternalOrganismId:string>?
< The name of the paternal species constituting the hybrid organism shall be specified.; (xsd)paternalOrganismName:string>?
< The hybrid type of an organism shall be specified.; (xsd)hybridType:CodeableConcept>?🔗 4.9.13.7.1 Kingdom (Conditional).SubstanceSourceMaterial.organism.organismGeneral(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The kingdom of an organism shall be specified.; (xsd)kingdom:CodeableConcept>?
< The phylum of an organism shall be specified.; (xsd)phylum:CodeableConcept>?
< The class of an organism shall be specified.; (xsd)class:CodeableConcept>?
< The order of an organism shall be specified,.; (xsd)order:CodeableConcept>?🔗 To do.SubstanceSourceMaterial.partDescription(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Entity of anatomical origin of source material within an organism.; (xsd)part:CodeableConcept>?
< The detailed anatomic location when the part can be extracted from different anatomical locations of the organism. Multiple alternative locations may apply.; (xsd)partLocation:CodeableConcept>?🔗 Record of delivery of what is supplied.SupplyDelivery(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< Identifier for the supply delivery event that is used to identify it across multiple disparate systems. This identifier is typically assigned by the supplier, and may be used to reference the delivery when exchanging information about it with other systems.; (xsd)identifier:Identifier>*
[]< A plan, proposal or order that is fulfilled in whole or in part by this event.; (xsd)basedOn:SupplyRequest*>*
[]< A larger event of which this particular event is a component or step. Not to be used to link an event to an Encounter - use Event.context for that.
[The allowed reference resources may be adjusted as appropriate for the event resource].; (xsd)partOf:(<Contract>
|<SupplyDelivery>)>*
< A code specifying the state of the dispense event. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. Binding: supplydelivery-status (required, Status of the supply delivery.); (xsd)status:code>?
< A link to a resource representing the person whom the delivered item is for.; (xsd)patient:Patient*>?
< Indicates the type of supply being provided. Examples include: Medication, Device, Biologically Derived Product. Binding: supplydelivery-supplyitemtype (required, The type of supply dispense.); (xsd)type:CodeableConcept>?
[]< The item that is being delivered or has been supplied.; (xsd)suppliedItem:SupplyDelivery.suppliedItem>*
< The date or time(s) the activity occurred. [The list of types may be constrained as appropriate for the type of event].; (xsd)occurrence:(<dateTime>
|<Period>
|<Timing>)>?
< The individual or organization responsible for supplying the delivery.; (xsd)supplier:(<Organization>
|<Practitioner>
|<PractitionerRole>)>?
< Identification of the facility/location where the delivery was shipped to.; (xsd)destination:Location*>?
[]< Identifies the individual or organization that received the delivery.; (xsd)receiver:(<Organization>
|<Practitioner>
|<PractitionerRole>)>*🔗 The item that is being delivered or has been supplied.SupplyDelivery.suppliedItem(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The amount of the item that has been supplied. Unit of measure may be included.; (xsd)quantity:SimpleQuantity>?
< Identifies the medication, substance, device or biologically derived product being supplied. This is either a link to a resource representing the details of the item or a code that identifies the item from a known list. Binding: supplydelivery-supplyitemtype (example, The item that was delivered.); (xsd)item:(<BiologicallyDerivedProduct>
|<CodeableConcept>
|<Device>
|<InventoryItem>
|<Medication>
|<NutritionProduct>
|<Substance>)>?🔗 A record of a request to deliver a medication, substance or device used in the healthcare setting to a particular destination for a particular person or organization.SupplyRequest(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< Business identifiers assigned to this SupplyRequest by the author and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server. The identifier.type element is used to distinguish between the identifiers assigned by the requester/placer and the performer/filler.; (xsd)identifier:Identifier>*
< Status of the supply request. Binding: supplyrequest-status (required, Status of the supply request.); (xsd)status:code>?
[]< Plan/proposal/order fulfilled by this request.; (xsd)basedOn:Resource*>*
< Category of supply, e.g. central, non-stock, etc. This is used to support work flows associated with the supply process. Binding: supplyrequest-kind (example, Category of supply request.); (xsd)category:CodeableConcept>?
< Indicates how quickly this SupplyRequest should be addressed with respect to other requests. Binding: request-priority (required, Identifies the level of importance to be assigned to actioning the request.); (xsd)priority:code>?
< The patient to whom the supply will be given or for whom they will be used.; (xsd)deliverFor:Patient*>?
< The item that is requested to be supplied. This is either a link to a resource representing the details of the item or a code that identifies the item from a known list. Note that there's a difference between a prescription - an instruction to take a medication, along with a (sometimes) implicit supply, and an explicit request to supply, with no explicit instructions. Binding: supply-item (example, The item that was requested.); (xsd)item:(<BiologicallyDerivedProduct>
|<Device>
|<DeviceDefinition>
|<InventoryItem>
|<Medication>
|<NutritionProduct>
|<Substance>)>
< The amount that is being ordered of the indicated item.; (xsd)quantity:Quantity>
[]< Specific parameters for the ordered item. For example, the size of the indicated item.; (xsd)parameter:SupplyRequest.parameter>*
< When the request should be fulfilled.; (xsd)occurrence:(<dateTime>
|<Period>
|<Timing>)>?
< When the request was made.; (xsd)authoredOn:dateTime>?
< The device, practitioner, etc. who initiated the request.; (xsd)requester:(<CareTeam>
|<Device>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>?
[]< Who is intended to fulfill the request.; (xsd)supplier:(<HealthcareService>
|<Organization>)>*
[]< The reason why the supply item was requested. Binding: supplyrequest-reason (example, The reason why the supply item was requested.); (xsd)reason:(<Condition>
|<DiagnosticReport>
|<DocumentReference>
|<Observation>)>*
< Where the supply is expected to come from.; (xsd)deliverFrom:(<Location>
|<Organization>)>?
< Where the supply is destined to go.; (xsd)deliverTo:(<Location>
|<Organization>
|<Patient>
|<RelatedPerson>)>?🔗 Specific parameters for the ordered item. For example, the size of the indicated item.SupplyRequest.parameter(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A code or string that identifies the device detail being asserted. Binding: (example, A code that identifies the device detail.); (xsd)code:CodeableConcept>?
(<valueBoolean:boolean>
|<valueCodeableConcept:CodeableConcept>
|<valueQuantity:Quantity>
|<valueRange:Range>)?🔗 A task to be performed.Task(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< The business identifier for this task.; (xsd)identifier:Identifier>*
< The URL pointing to a *FHIR*-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Task.; (xsd)instantiatesCanonical:ActivityDefinition*>?
< The URL pointing to an *externally* maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Task.; (xsd)instantiatesUri:uri>?
[]< BasedOn refers to a higher-level authorization that triggered the creation of the task. It references a "request" resource such as a ServiceRequest, MedicationRequest, CarePlan, etc. which is distinct from the "request" resource the task is seeking to fulfill. This latter resource is referenced by focus. For example, based on a CarePlan (= basedOn), a task is created to fulfill a ServiceRequest ( = focus ) to collect a specimen from a patient. Task.basedOn is never the same as Task.focus. Task.basedOn will typically not be present for 'please fulfill' Tasks as a distinct authorization is rarely needed to request fulfillment. If the Task is seeking fulfillment of an order, the order to be fulfilled is always communicated using `focus`, never basedOn. However, authorization may be needed to perform other types of Task actions. As an example of when both would be present, a Task seeking suspension of a prescription might have a Task.basedOn pointing to the ServiceRequest ordering surgery (which is the driver for suspending the MedicationRequest - which would be the Task.focus).; (xsd)basedOn:Resource*>*
< A shared identifier common to multiple independent Task and Request instances that were activated/authorized more or less simultaneously by a single author. The presence of the same identifier on each request ties those requests together and may have business ramifications in terms of reporting of results, billing, etc. E.g. a requisition number shared by a set of lab tests ordered together, or a prescription number shared by all meds ordered at one time.; (xsd)groupIdentifier:Identifier>?
[]< Task that this particular task is part of. This should usually be 0..1.; (xsd)partOf:Task*>*
< The current status of the task. Binding: task-status (required, The current status of the task.); (xsd)status:code>
< An explanation as to why this task is held, failed, was refused, etc. This applies to the current status. Look at the history of the task to see reasons for past statuses. Binding: task-status-reason (example, Codes to identify the reason for current status. These will typically be specific to a particular workflow.); (xsd)statusReason:Resource*>?
< Contains business-specific nuances of the business state. Binding: (example, The domain-specific business-contextual sub-state of the task. For example: "Blood drawn", "IV inserted", "Awaiting physician signature", etc.); (xsd)businessStatus:CodeableConcept>?
< Indicates the "level" of actionability associated with the Task, i.e. i+R[9]Cs this a proposed task, a planned task, an actionable task, etc. This element is immutable. Proposed tasks, planned tasks, etc. must be distinct instances.
In most cases, Tasks will have an intent of "order". Binding: task-intent (required, Distinguishes whether the task is a proposal, plan or full order.); (xsd)intent:code>
< Indicates how quickly the Task should be addressed with respect to other requests. Binding: request-priority (required, The priority of a task (may affect service level applied to the task).); (xsd)priority:code>?
< If true indicates that the Task is asking for the specified action to *not* occur. The attributes provided with the Task qualify what is not to be done. For example, if a requestedPeriod is provided, the 'do not' request only applies within the specified time. If a requestedPerformer is specified then the 'do not' request only applies to performers of that type. Qualifiers include: code, subject, occurrence, requestedPerformer and performer.
In some cases, the Request.code may pre-coordinate prohibition into the requested action. E.g. 'NPO' (nothing by mouth), 'DNR' (do not recussitate). If this happens, doNotPerform SHALL NOT be set to true. I.e. The resource shall not have double negation. (E.g. 'Do not DNR').
doNotPerform should ONLY be used with Tasks that are tightly bounded in time or process phase. E.g. 'Do not fulfill the midnight dose of medication X tonight due to the early morning scheduled procedure, where the nurse could reasonably check off 'Med X not given at midnight as instructed'. Similarly, a decision support proposal that a patient should not be given a standard intake questionnaire (because the patient is cognitively impaired) would be marked as 'complete' or 'rejected' when the clinician preps the CarePlan or order set after reviewing the decision support results. If there is a need to create a standing order to not do something that can't be satisfied by a single 'non-action', but rather an ongoing refusal to perform the function, MedicationRequest, ServiceRequest or some other form of authorization should be used.; (xsd)doNotPerform:boolean>?
< A name or code (or both) briefly describing what the task involves. The title (eg "My Tasks", "Outstanding Tasks for Patient X") should go into the code. Binding: task-code (example, Codes to identify what the task involves. These will typically be specific to a particular workflow.); (xsd)code:CodeableConcept>?
< A free-text description of what is to be performed.; (xsd)description:string>?
< The request being fulfilled or the resource being manipulated (changed, suspended, etc.) by this task. If multiple resources need to be manipulated, use sub-tasks. (This ensures that status can be tracked independently for each referenced resource.).; (xsd)focus:Resource*>?
< The entity who benefits from the performance of the service specified in the task (e.g., the patient).; (xsd)for:Resource*>?
< The healthcare event (e.g. a patient and healthcare provider interaction) during which this task was created.; (xsd)encounter:Encounter*>?
< Indicates the start and/or end of the period of time when completion of the task is desired to take place. This is typically used when the Task is *not* seeking fulfillment of a focus Request, as in that case the period would be specified on the Request and/or in the Task.restriction.period. Instead, it is used for stand-alone tasks.; (xsd)requestedPeriod:Period>?
< Identifies the time action was first taken against the task (start) and/or the time final action was taken against the task prior to marking it as completed (end).; (xsd)executionPeriod:Period>?
< The date and time this task was created.; (xsd)authoredOn:dateTime>?
< The date and time of last modification to this task.; (xsd)lastModified:dateTime>?
< The creator of the task.; (xsd)requester:(<Device>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>?
[]< The kind of participant or specific participant that should perform the task. Binding: performer-role (preferred, The type(s) of task performers allowed.); (xsd)requestedPerformer:(<CareTeam>
|<Device>
|<HealthcareService>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>*
< Party responsible for managing task execution. Tasks may be created with an owner not yet identified.; (xsd)owner:(<CareTeam>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>?
[]< The entity who performed the requested task.; (xsd)performer:Task.performer>*
< Principal physical location where this task is performed. This should only be specified when the Task to be/being performed happens or is expected to happen primarily within the bounds of a single Location. Other locations (e.g. source, destination, etc.) would either be reflected on the 'basedOn' Request or be conveyed as distinct Task.input values.; (xsd)location:Location*>?
[]< A description, code, or reference indicating why this task needs to be performed. This will typically not be present for Tasks with a code of 'please fulfill' as, for those, the reason for action is conveyed on the Request pointed to by Task.focus. Some types of tasks will not need a 'reason'. E.g. a request to discharge a patient can be inferred to be 'because the patient is ready' and this would not need a reason to be stated on the Task. Binding: (example, Indicates why the task is needed. E.g. Suspended because patient admitted to hospital.); (xsd)reason:Resource*>*
[]< Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be relevant to the Task.; (xsd)insurance:(<ClaimResponse>
|<Coverage>)>*
[]< Free-text information captured about the task as it progresses.; (xsd)note:Annotation>*
[]< Links to Provenance records for past versions of this Task that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the task. This element does not point to the Provenance associated with the *current* version of the resource - as it would be created after this version existed. The Provenance for the current version can be retrieved with a _revinclude.; (xsd)relevantHistory:Provenance*>*
< If the Task.focus is a request resource and the task is seeking fulfillment (i.e. is asking for the request to be actioned), this element identifies any limitations on what parts of the referenced request should be actioned. Task.restriction can only be present if the Task is seeking fulfillment of another Request resource, and the restriction identifies what subset of the authorization conveyed by the request is supposed to be fulfilled by this Task. A possible example could be a standing order (the request) covering a significant time period and/or individuals, while the Task seeks fulfillment for only a subset of that time-period and a single individual.; (xsd)restriction:Task.restriction>?
[]< Additional information that may be needed in the execution of the task.; (xsd)input:Task.input>*
[]< Outputs produced by the Task.; (xsd)output:Task.output>*🔗 Additional information that may be needed in the execution of the task.Task.input(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A code or description indicating how the input is intended to be used as part of the task execution. If referencing a BPMN workflow or Protocol, the "system" is the URL for the workflow definition and the code is the "name" of the required input. Binding: (example, Codes to identify types of input parameters. These will typically be specific to a particular workflow. E.g. "Comparison source", "Applicable consent", "Concomitent Medications", etc.); (xsd)type:CodeableConcept>
(<valueAddress:Address>
|<valueAge:Age>
|<valueAnnotation:Annotation>
|<valueAttachment:Attachment>
|<valueAvailability:Availability>
|<valueBase64Binary:base64Binary>
|<valueBoolean:boolean>
|<valueCode:code>
|<valueCodeableConcept:CodeableConcept>
|<valueCoding:Coding>
|<valueContactDetail:ContactDetail>
|<valueContactPoint:ContactPoint>
|<valueCount:Count>
|<valueDataRequirement:DataRequirement>
|<valueDate:date>
|<valueDateTime:dateTime>
|<valueDecimal:decimal>
|<valueDistance:Distance>
|<valueDosage:Dosage>
|<valueDuration:Duration>
|<valueExpression:Expression>
|<valueExtendedContactDetail:ExtendedContactDetail>
|<valueHumanName:HumanName>
|<valueId:id>
|<valueIdentifier:Identifier>
|<valueInstant:instant>
|<valueInteger:integer>
|<valueInteger64:integer64>
|<valueMarkdown:markdown>
|<valueMeta:Meta>
|<valueMoney:Money>
|<valueOid:oid>
|<valueParameterDefinition:ParameterDefinition>
|<valuePeriod:Period>
|<valuePositiveInt:positiveInt>
|<valueQuantity:Quantity>
|<valueRange:Range>
|<valueRatio:Ratio>
|<valueRatioRange:RatioRange>
|<valueRelatedArtifact:RelatedArtifact>
|<valueResource:Resource>
|<valueSampledData:SampledData>
|<valueSignature:Signature>
|<valueString:string>
|<valueTime:time>
|<valueTiming:Timing>
|<valueTriggerDefinition:TriggerDefinition>
|<valueUnsignedInt:unsignedInt>
|<valueUri:uri>
|<valueUrl:url>
|<valueUsageContext:UsageContext>
|<valueUuid:uuid>)🔗 Outputs produced by the Task.Task.output(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The name of the Output parameter. Binding: (example, Codes to identify types of input parameters. These will typically be specific to a particular workflow. E.g. "Identified issues", "Preliminary results", "Filler order", "Final results", etc.); (xsd)type:CodeableConcept>
(<valueAddress:Address>
|<valueAge:Age>
|<valueAnnotation:Annotation>
|<valueAttachment:Attachment>
|<valueAvailability:Availability>
|<valueBase64Binary:base64Binary>
|<valueBoolean:boolean>
|<valueCode:code>
|<valueCodeableConcept:CodeableConcept>
|<valueCoding:Coding>
|<valueContactDetail:ContactDetail>
|<valueContactPoint:ContactPoint>
|<valueCount:Count>
|<valueDataRequirement:DataRequirement>
|<valueDate:date>
|<valueDateTime:dateTime>
|<valueDecimal:decimal>
|<valueDistance:Distance>
|<valueDosage:Dosage>
|<valueDuration:Duration>
|<valueExpression:Expression>
|<valueExtendedContactDetail:ExtendedContactDetail>
|<valueHumanName:HumanName>
|<valueId:id>
|<valueIdentifier:Identifier>
|<valueInstant:instant>
|<valueInteger:integer>
|<valueInteger64:integer64>
|<valueMarkdown:markdown>
|<valueMeta:Meta>
|<valueMoney:Money>
|<valueOid:oid>
|<valueParameterDefinition:ParameterDefinition>
|<valuePeriod:Period>
|<valuePositiveInt:positiveInt>
|<valueQuantity:Quantity>
|<valueRange:Range>
|<valueRatio:Ratio>
|<valueRatioRange:RatioRange>
|<valueRelatedArtifact:RelatedArtifact>
|<valueResource:Resource>
|<valueSampledData:SampledData>
|<valueSignature:Signature>
|<valueString:string>
|<valueTime:time>
|<valueTiming:Timing>
|<valueTriggerDefinition:TriggerDefinition>
|<valueUnsignedInt:unsignedInt>
|<valueUri:uri>
|<valueUrl:url>
|<valueUsageContext:UsageContext>
|<valueUuid:uuid>)🔗 The entity who performed the requested task.Task.performer(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A code or description of the performer of the task. Binding: (example, Codes to identify types of task performers.); (xsd)function:CodeableConcept>?
< The actor or entity who performed the task.; (xsd)actor:(<CareTeam>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>🔗 If the Task.focus is a request resource and the task is seeking fulfillment (i.e. is asking for the request to be actioned), this element identifies any limitations on what parts of the referenced request should be actioned. Task.restriction can only be present if the Task is seeking fulfillment of another Request resource, and the restriction identifies what subset of the authorization conveyed by the request is supposed to be fulfilled by this Task. A possible example could be a standing order (the request) covering a significant time period and/or individuals, while the Task seeks fulfillment for only a subset of that time-period and a single individual.Task.restriction(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Indicates the number of times the requested action should occur.; (xsd)repetitions:positiveInt>?
< The time-period for which fulfillment is sought. This must fall within the overall time period authorized in the referenced request. E.g. ServiceRequest.occurance[x]. This is distinct from Task.executionPeriod. ExecutionPeriod indicates when the task needs to be initiated, while Task.restriction.period specifies the subset of the overall authorization that this period covers. For example, a MedicationRequest with an overall effective period of 1 year might have a Task whose restriction.period is 2 months (i.e. satisfy 2 months of medication therapy), while the execution period might be 'between now and 5 days from now' - i.e. If you say yes to this, then you're agreeing to supply medication for that 2 month period within the next 5 days.
Note that period.high is the due date representing the time by which the task should be completed.; (xsd)period:Period>?
[]< For requests that are targeted to more than one potential recipient/target, to identify who is fulfillment is sought for.; (xsd)recipient:(<Group>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>*🔗 A TerminologyCapabilities resource documents a set of capabilities (behaviors) of a FHIR Terminology Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.TerminologyCapabilities(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< An absolute URI that is used to identify this terminology capabilities when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this terminology capabilities is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the terminology capabilities is stored on different servers. Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.
The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions).
In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.; (xsd)url:uri>?
[]< A formal identifier that is used to identify this terminology capabilities when it is represented in other formats, or referenced in a specification, model, design or an instance. Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this terminology capabilities outside of FHIR, where it is not possible to use the logical URI.; (xsd)identifier:Identifier>*
< The identifier that is used to identify this version of the terminology capabilities when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the terminology capabilities author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. There may be different terminology capabilities instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the terminology capabilities with the format [url]|[version]. The version SHOULD NOT contain a '#' - see [Business Version](resource.html#bv-format).; (xsd)version:string>?
< Indicates the mechanism used to compare versions to determine which is more current. If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined. Binding: version-algorithm (extensible, ); (xsd)versionAlgorithm:(<Coding>
|<string>)>?
< A natural language name identifying the terminology capabilities. This name should be usable as an identifier for the module by machine processing applications such as code generation. The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.; (xsd)name:string>?
< A short, descriptive, user-friendly title for the terminology capabilities. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.; (xsd)title:string>?
< The status of this terminology capabilities. Enables tracking the life-cycle of the content. Allows filtering of terminology capabilitiess that are appropriate for use versus not.This is not intended for use with actual capability statements, but where capability statements are used to describe possible or desired systems.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization). Binding: publication-status (required, The lifecycle status of an artifact.); (xsd)status:code>
< A Boolean value to indicate that this terminology capabilities is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. Allows filtering of terminology capabilitiess that are appropriate for use versus not.; (xsd)experimental:boolean>?
< The date (and optionally time) when the terminology capabilities was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the terminology capabilities changes. The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the terminology capabilities. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)date:dateTime>
< The name of the organization or individual responsible for the release and ongoing maintenance of the terminology capabilities. Usually an organization but may be an individual. The publisher (or steward) of the terminology capabilities is the organization or individual primarily responsible for the maintenance and upkeep of the terminology capabilities. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the terminology capabilities. This item SHOULD be populated unless the information is available from context.; (xsd)publisher:string>?
[]< Contact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)contact:ContactDetail>*
< A free text natural language description of the terminology capabilities from a consumer's perspective. Typically, this is used when the capability statement describes a desired rather than an actual solution, for example as a formal expression of requirements as part of an RFP. This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the terminology capabilities as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the terminology capabilities is presumed to be the predominant language in the place the terminology capabilities was created).This does not need to be populated if the description is adequately implied by the software or implementation details.; (xsd)description:markdown>?
[]< The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate terminology capabilities instances. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.; (xsd)useContext:UsageContext>*
[]< A legal or geographic region in which the terminology capabilities is intended to be used. It may be possible for the terminology capabilities to be used in jurisdictions other than those for which it was originally designed or intended.
DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.) Binding: jurisdiction (extensible, Countries and regions within which this artifact is targeted for use.); (xsd)jurisdiction:CodeableConcept>*
< Explanation of why this terminology capabilities is needed and why it has been designed as it has. This element does not describe the usage of the terminology capabilities. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this terminology capabilities.; (xsd)purpose:markdown>?
< A copyright statement relating to the terminology capabilities and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the terminology capabilities.; (xsd)copyright:markdown>?
< A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved'). The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.; (xsd)copyrightLabel:string>?
< The way that this statement is intended to be used, to describe an actual running instance of software, a particular product (kind, not instance of software) or a class of implementation (e.g. a desired purchase). Binding: capability-statement-kind (required, How a capability statement is intended to be used.); (xsd)kind:code>
< Software that is covered by this terminology capability statement. It is used when the statement describes the capabilities of a particular software version, independent of an installation.; (xsd)software:TerminologyCapabilities.software>?
< Identifies a specific implementation instance that is described by the terminology capability statement - i.e. a particular installation, rather than the capabilities of a software program.; (xsd)implementation:TerminologyCapabilities.implementation>?
< Whether the server supports lockedDate.; (xsd)lockedDate:boolean>?
[]< Identifies a code system that is supported by the server. If there is a no code system URL, then this declares the general assumptions a client can make about support for any CodeSystem resource. The code system - identified by its system URL - may also be declared explicitly as a Code System Resource at /CodeSystem, but it might not be.; (xsd)codeSystem:TerminologyCapabilities.codeSystem>*
< Information about the [ValueSet/$expand](valueset-operation-expand.html) operation.; (xsd)expansion:TerminologyCapabilities.expansion>?
< The degree to which the server supports the code search parameter on ValueSet, if it is supported. See notes on the [ValueSet](valueset.html#) resource. Binding: code-search-support (required, The degree to which the server supports the code search parameter on ValueSet, if it is supported.); (xsd)codeSearch:code>?
< Information about the [ValueSet/$validate-code](valueset-operation-validate-code.html) operation.; (xsd)validateCode:TerminologyCapabilities.validateCode>?
< Information about the [ConceptMap/$translate](conceptmap-operation-translate.html) operation.; (xsd)translation:TerminologyCapabilities.translation>?
< Whether the $closure operation is supported.; (xsd)closure:TerminologyCapabilities.closure>?🔗 Whether the $closure operation is supported.TerminologyCapabilities.closure(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< If cross-system closure is supported.; (xsd)translation:boolean>?🔗 Identifies a code system that is supported by the server. If there is a no code system URL, then this declares the general assumptions a client can make about support for any CodeSystem resource. The code system - identified by its system URL - may also be declared explicitly as a Code System Resource at /CodeSystem, but it might not be.TerminologyCapabilities.codeSystem(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Canonical identifier for the code system, represented as a URI.; (xsd)uri:CodeSystem*>?
[]< For the code system, a list of versions that are supported by the server. Language translations might not be available for all codes.; (xsd)version:TerminologyCapabilities.codeSystem.version>*
< The extent of the content of the code system (the concepts and codes it defines) are represented in this resource instance. Binding: codesystem-content-mode (required, The extent of the content of the code system (the concepts and codes it defines) are represented in a code system resource.); (xsd)content:code>
< True if subsumption is supported for this version of the code system.; (xsd)subsumption:boolean>?🔗 For the code system, a list of versions that are supported by the server. Language translations might not be available for all codes.TerminologyCapabilities.codeSystem.version(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< For version-less code systems, there should be a single version with no identifier.; (xsd)code:string>?
< If this is the default version for this code system.; (xsd)isDefault:boolean>?
< If the compositional grammar defined by the code system is supported.; (xsd)compositional:boolean>?
[]< Language Displays supported. Binding: languages (required, IETF language tag); (xsd)language:code>*
[]< Filter Properties supported.; (xsd)filter:TerminologyCapabilities.codeSystem.version.filter>*
[]< Properties supported for $lookup.; (xsd)property:code>*🔗 Filter Properties supported.TerminologyCapabilities.codeSystem.version.filter(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Code of the property supported.; (xsd)code>
[]< Operations supported for the property.; (xsd)op:code>+🔗 Information about the [ValueSet/$expand](valueset-operation-expand.html) operation.TerminologyCapabilities.expansion(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Whether the server can return nested value sets.; (xsd)hierarchical:boolean>?
< Whether the server supports paging on expansion.; (xsd)paging:boolean>?
< True if requests for incomplete expansions are allowed.; (xsd)incomplete:boolean>?
[]< Supported expansion parameter.; (xsd)parameter:TerminologyCapabilities.expansion.parameter>*
< Documentation about text searching works. This documentation should cover things like case sensitivity, use of punctuation if not ignored, what wild cards are supported (if any), whether text is starts with or contains, and whether word order matters.; (xsd)textFilter:markdown>?🔗 Supported expansion parameter.TerminologyCapabilities.expansion.parameter(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Name of the supported expansion parameter.; (xsd)name:code>
< Description of support for parameter.; (xsd)documentation:string>?🔗 Identifies a specific implementation instance that is described by the terminology capability statement - i.e. a particular installation, rather than the capabilities of a software program.TerminologyCapabilities.implementation(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Information about the specific installation that this terminology capability statement relates to.; (xsd)description:string>
< An absolute base URL for the implementation.; (xsd)url>?🔗 Software that is covered by this terminology capability statement. It is used when the statement describes the capabilities of a particular software version, independent of an installation.TerminologyCapabilities.software(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Name the software is known by.; (xsd)name:string>
< The version identifier for the software covered by this statement. If possible, a version should be specified, as statements are likely to be different for different versions of software.; (xsd)version:string>?🔗 Information about the [ConceptMap/$translate](conceptmap-operation-translate.html) operation.TerminologyCapabilities.translation(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Whether the client must identify the map.; (xsd)needsMap:boolean>🔗 Information about the [ValueSet/$validate-code](valueset-operation-validate-code.html) operation.TerminologyCapabilities.validateCode(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Whether translations are validated.; (xsd)translations:boolean>🔗 A plan for executing testing on an artifact or specifications.TestPlan(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< An absolute URI that is used to identify this test plan when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this test plan is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the test plan is stored on different servers. Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.
The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions).
In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.; (xsd)url:uri>?
[]< A formal identifier that is used to identify this test plan when it is represented in other formats, or referenced in a specification, model, design or an instance. Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this test plan outside of FHIR, where it is not possible to use the logical URI.; (xsd)identifier:Identifier>*
< The identifier that is used to identify this version of the test plan when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the test plan author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. There may be different test plan instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the test plan with the format [url]|[version]. The version SHOULD NOT contain a '#' - see [Business Version](resource.html#bv-format).; (xsd)version:string>?
< Indicates the mechanism used to compare versions to determine which is more current. If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined. Binding: version-algorithm (extensible, ); (xsd)versionAlgorithm:(<Coding>
|<string>)>?
< A natural language name identifying the test plan. This name should be usable as an identifier for the module by machine processing applications such as code generation. The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.; (xsd)name:string>?
< A short, descriptive, user-friendly title for the test plan. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.; (xsd)title:string>?
< The status of this test plan. Enables tracking the life-cycle of the content. Allows filtering of test plans that are appropriate for use versus not.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization). Binding: publication-status (required, The lifecycle status of an artifact.); (xsd)status:code>
< A Boolean value to indicate that this test plan is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. Allows filtering of test plans that are appropriate for use versus not.; (xsd)experimental:boolean>?
< The date (and optionally time) when the test plan was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the test plan changes. The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the test plan. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)date:dateTime>?
< The name of the organization or individual responsible for the release and ongoing maintenance of the test plan. Usually an organization but may be an individual. The publisher (or steward) of the test plan is the organization or individual primarily responsible for the maintenance and upkeep of the test plan. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the test plan. This item SHOULD be populated unless the information is available from context.; (xsd)publisher:string>?
[]< Contact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)contact:ContactDetail>*
< A free text natural language description of the test plan from a consumer's perspective. This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the test plan as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the test plan is presumed to be the predominant language in the place the test plan was created).; (xsd)description:markdown>?
[]< The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate test plan instances. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.; (xsd)useContext:UsageContext>*
[]< A legal or geographic region in which the test plan is intended to be used. It may be possible for the test plan to be used in jurisdictions other than those for which it was originally designed or intended.
DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.) Binding: jurisdiction (extensible, Countries and regions within which this artifact is targeted for use.); (xsd)jurisdiction:CodeableConcept>*
< Explanation of why this test plan is needed and why it has been designed as it has. This element does not describe the usage of the test plan Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this test plan.; (xsd)purpose:markdown>?
< A copyright statement relating to the test plan and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the test plan. The short copyright declaration (e.g. (c) '2015+ xyz organization' should be sent in the copyrightLabel element.; (xsd)copyright:markdown>?
< A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved'). The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.; (xsd)copyrightLabel:string>?
[]< The category of the Test Plan - can be acceptance, unit, performance, etc. Binding: testscript-scope-phase-codes (example, The high-level category for this plan.); (xsd)category:CodeableConcept>*
[]< What is being tested with this Test Plan - a conformance resource, or narrative criteria, or an external reference...; (xsd)scope:Resource*>*
< A description of test tools to be used in the test plan.; (xsd)testTools:markdown>?
[]< The required criteria to execute the test plan - e.g. preconditions, previous tests...; (xsd)dependency:TestPlan.dependency>*
< The threshold or criteria for the test plan to be considered successfully executed - narrative.; (xsd)exitCriteria:markdown>?
[]< The individual test cases that are part of this plan, when they they are made explicit.; (xsd)testCase:TestPlan.testCase>*🔗 The required criteria to execute the test plan - e.g. preconditions, previous tests...TestPlan.dependency(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A textual description of the criterium - what is needed for the dependency to be considered met.; (xsd)description:markdown>?
< Predecessor test plans - those that are expected to be successfully performed as a dependency for the execution of this test plan.; (xsd)predecessor:Resource*>?🔗 The individual test cases that are part of this plan, when they they are made explicit.TestPlan.testCase(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Sequence of test case - an ordinal number that indicates the order for the present test case in the test plan.; (xsd)sequence:integer>?
[]< The scope or artifact covered by the case, when the individual test case is associated with a testable artifact.; (xsd)scope:Resource*>*
[]< The required criteria to execute the test case - e.g. preconditions, previous tests.; (xsd)dependency:TestPlan.testCase.dependency>*
[]< The actual test to be executed.; (xsd)testRun:TestPlan.testCase.testRun>*
[]< The test data used in the test case.; (xsd)testData:TestPlan.testCase.testData>*
[]< The test assertions - the expectations of test results from the execution of the test case.; (xsd)assertion:TestPlan.testCase.assertion>*🔗 The test assertions - the expectations of test results from the execution of the test case.TestPlan.testCase.assertion(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< The test assertion type - this can be used to group assertions as 'required' or 'optional', or can be used for other classification of the assertion.; (xsd)type:CodeableConcept>*
[]< The focus or object of the assertion i.e. a resource.; (xsd)object:Resource*>*
[]< The test assertion - the expected outcome from the test case execution.; (xsd)result:Resource*>*🔗 The required criteria to execute the test case - e.g. preconditions, previous tests.TestPlan.testCase.dependency(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Description of the criteria.; (xsd)description:markdown>?
< Link to predecessor test plans.; (xsd)predecessor:Resource*>?🔗 The test data used in the test case.TestPlan.testCase.testData(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The type of test data description, e.g. 'synthea'.; (xsd)type:Coding>
< The actual test resources when they exist.; (xsd)content:Resource*>?
< Pointer to a definition of test resources - narrative or structured e.g. synthetic data generation, etc.; (xsd)source:(<Resource>
|<string>)>?🔗 The actual test to be executed.TestPlan.testCase.testRun(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The narrative description of the tests.; (xsd)narrative:markdown>?
< The test cases in a structured language e.g. gherkin, Postman, or FHIR TestScript.; (xsd)script:TestPlan.testCase.testRun.script>?🔗 The test cases in a structured language e.g. gherkin, Postman, or FHIR TestScript.TestPlan.testCase.testRun.script(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The language for the test cases e.g. 'gherkin', 'testscript'.; (xsd)language:CodeableConcept>?
< The actual content of the cases - references to TestScripts or externally defined content.; (xsd)source:(<Resource>
|<string>)>?🔗 A summary of information based on the results of executing a TestScript.TestReport(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< Identifier for the TestReport assigned for external purposes outside the context of FHIR.; (xsd)identifier:Identifier>?
< A free text natural language name identifying the executed TestReport. Not expected to be globally unique.; (xsd)name:string>?
< The current state of this test report. The status represents where the execution is currently within the test script execution life cycle.
This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. Binding: report-status-codes (required, The current status of the test script execution.); (xsd)status:code>
< Ideally this is an absolute URL that is used to identify the version-specific TestScript that was executed, matching the `TestScript.url`.; (xsd)testScript:TestScript*>
< The overall result from the execution of the TestScript. The pass and fail result represents a completed test script execution. The pending result represents a test script execution that has not yet started or is currently in progress. Binding: report-result-codes (required, The overall execution result of the TestScript.); (xsd)result:code>
< The final score (percentage of tests passed) resulting from the execution of the TestScript.; (xsd)score:decimal>?
< Name of the tester producing this report (Organization or individual). Usually an organization, but may be an individual. This item SHOULD be populated unless the information is available from context.; (xsd)tester:string>?
< When the TestScript was executed and this TestReport was generated. Additional specific dates may be added as extensions.; (xsd)issued:dateTime>?
[]< A participant in the test execution, either the execution engine, a client, or a server.; (xsd)participant:TestReport.participant>*
< The results of the series of required setup operations before the tests were executed.; (xsd)setup:TestReport.setup>?
[]< A test executed from the test script.; (xsd)test:TestReport.test>*
< The results of the series of operations required to clean up after all the tests were executed (successfully or otherwise).; (xsd)teardown:TestReport.teardown>?🔗 A participant in the test execution, either the execution engine, a client, or a server.TestReport.participant(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The type of participant. Binding: report-participant-type (required, The type of participant.); (xsd)type:code>
< The uri of the participant. An absolute URL is preferred.; (xsd)uri>
< The display name of the participant.; (xsd)display:string>?🔗 The results of the series of required setup operations before the tests were executed.TestReport.setup(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< Action would contain either an operation or an assertion. An action should contain either an operation or an assertion but not both. It can contain any number of variables.; (xsd)action:TestReport.setup.action>+🔗 Action would contain either an operation or an assertion. An action should contain either an operation or an assertion but not both. It can contain any number of variables.TestReport.setup.action(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The operation performed.; (xsd)operation:TestReport.setup.action.operation>?
< The results of the assertion performed on the previous operations.; (xsd)assert:TestReport.setup.action.assert>?🔗 The results of the assertion performed on the previous operations.TestReport.setup.action.assert(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The result of this assertion. Binding: report-action-result-codes (required, The result of the execution of an individual action.); (xsd)result:code>
< An explanatory message associated with the result.; (xsd)message:markdown>?
< A link to further details on the result.; (xsd)detail:string>?
[]< Links or references providing traceability to the testing requirements for this assert. TestScript and TestReport instances are typically (and expected to be) based on known, defined test requirements and documentation. These links provide traceability from the executable/executed TestScript and TestReport tests to these requirements.; (xsd)requirement:TestReport.setup.action.assert.requirement>*🔗 Links or references providing traceability to the testing requirements for this assert. TestScript and TestReport instances are typically (and expected to be) based on known, defined test requirements and documentation. These links provide traceability from the executable/executed TestScript and TestReport tests to these requirements.TestReport.setup.action.assert.requirement(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Link or reference providing traceability to the testing requirement for this test.; (xsd)link:(<Requirements>
|<uri>)>?🔗 The operation performed.TestReport.setup.action.operation(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The result of this operation. Binding: report-action-result-codes (required, The result of the execution of an individual action.); (xsd)result:code>
< An explanatory message associated with the result.; (xsd)message:markdown>?
< A link to further details on the result.; (xsd)detail:uri>?🔗 The results of the series of operations required to clean up after all the tests were executed (successfully or otherwise).TestReport.teardown(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< The teardown action will only contain an operation. An action should contain either an operation or an assertion but not both. It can contain any number of variables.; (xsd)action:TestReport.teardown.action>+🔗 The teardown action will only contain an operation. An action should contain either an operation or an assertion but not both. It can contain any number of variables.TestReport.teardown.action(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< An operation would involve a REST request to a server.; (xsd)operation:TestReport.setup.action.operation>🔗 A test executed from the test script.TestReport.test(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The name of this test used for tracking/logging purposes by test engines.; (xsd)name:string>?
< A short description of the test used by test engines for tracking and reporting purposes.; (xsd)description:string>?
[]< Action would contain either an operation or an assertion. An action should contain either an operation or an assertion but not both. It can contain any number of variables.; (xsd)action:TestReport.test.action>+🔗 Action would contain either an operation or an assertion. An action should contain either an operation or an assertion but not both. It can contain any number of variables.TestReport.test.action(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< An operation would involve a REST request to a server.; (xsd)operation:TestReport.setup.action.operation>?
< The results of the assertion performed on the previous operations.; (xsd)assert:TestReport.setup.action.assert>?🔗 A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.TestScript(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< An absolute URI that is used to identify this test script when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this test script is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the test script is stored on different servers. Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.
The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions).
In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.; (xsd)url:uri>?
[]< A formal identifier that is used to identify this test script when it is represented in other formats, or referenced in a specification, model, design or an instance. Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this test script outside of FHIR, where it is not possible to use the logical URI.; (xsd)identifier:Identifier>*
< The identifier that is used to identify this version of the test script when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the test script author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. There may be different test script instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the test script with the format [url]|[version]. The version SHOULD NOT contain a '#' - see [Business Version](resource.html#bv-format).; (xsd)version:string>?
< Indicates the mechanism used to compare versions to determine which is more current. If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined. Binding: version-algorithm (extensible, ); (xsd)versionAlgorithm:(<Coding>
|<string>)>?
< A natural language name identifying the test script. This name should be usable as an identifier for the module by machine processing applications such as code generation. The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.; (xsd)name:string>
< A short, descriptive, user-friendly title for the test script. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.; (xsd)title:string>?
< The status of this test script. Enables tracking the life-cycle of the content. Allows filtering of test scripts that are appropriate for use versus not.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization). Binding: publication-status (required, The lifecycle status of an artifact.); (xsd)status:code>
< A Boolean value to indicate that this test script is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. Allows filtering of test scripts that are appropriate for use versus not.; (xsd)experimental:boolean>?
< The date (and optionally time) when the test script was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the test script changes. The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the test script. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)date:dateTime>?
< The name of the organization or individual responsible for the release and ongoing maintenance of the test script. Usually an organization but may be an individual. The publisher (or steward) of the test script is the organization or individual primarily responsible for the maintenance and upkeep of the test script. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the test script. This item SHOULD be populated unless the information is available from context.; (xsd)publisher:string>?
[]< Contact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)contact:ContactDetail>*
< A free text natural language description of the test script from a consumer's perspective. This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the test script as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the test script is presumed to be the predominant language in the place the test script was created).; (xsd)description:markdown>?
[]< The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate test script instances. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.; (xsd)useContext:UsageContext>*
[]< A legal or geographic region in which the test script is intended to be used. It may be possible for the test script to be used in jurisdictions other than those for which it was originally designed or intended.
DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.) Binding: jurisdiction (extensible, Countries and regions within which this artifact is targeted for use.); (xsd)jurisdiction:CodeableConcept>*
< Explanation of why this test script is needed and why it has been designed as it has. This element does not describe the usage of the test script. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this test script.; (xsd)purpose:markdown>?
< A copyright statement relating to the test script and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the test script.; (xsd)copyright:markdown>?
< A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved'). The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.; (xsd)copyrightLabel:string>?
[]< An abstract server used in operations within this test script in the origin element. The purpose of this element is to define the profile of an origin element used elsewhere in the script. Test engines could then use the origin-profile mapping to offer a filtered list of test systems that can serve as the sender for the interaction.; (xsd)origin:TestScript.origin>*
[]< An abstract server used in operations within this test script in the destination element. The purpose of this element is to define the profile of a destination element used elsewhere in the script. Test engines could then use the destination-profile mapping to offer a filtered list of test systems that can serve as the receiver for the interaction.; (xsd)destination:TestScript.destination>*
< The required capability must exist and are assumed to function correctly on the FHIR server being tested.; (xsd)metadata:TestScript.metadata>?
[]< The scope indicates a conformance artifact that is tested by the test(s) within this test case and the expectation of the test outcome(s) as well as the intended test phase inclusion.; (xsd)scope:TestScript.scope>*
[]< Fixture in the test script - by reference (uri). All fixtures are required for the test script to execute.; (xsd)fixture:TestScript.fixture>*
[]< Reference to the profile to be used for validation. See the [Resource List](resourcelist.html) for complete list of resource types.; (xsd)profile:StructureDefinition*>*
[]< Variable is set based either on element value in response body or on header field value in the response headers. Variables would be set based either on XPath/JSONPath expressions against fixtures (static and response), or headerField evaluations against response headers. If variable evaluates to nodelist or anything other than a primitive value, then test engine would report an error. Variables would be used to perform clean replacements in "operation.params", "operation.requestHeader.value", and "operation.url" element values during operation calls and in "assert.value" during assertion evaluations. This limits the places that test engines would need to look for placeholders "${}". Variables are scoped to the whole script. They are NOT evaluated at declaration. They are evaluated by test engine when used for substitutions in "operation.params", "operation.requestHeader.value", and "operation.url" element values during operation calls and in "assert.value" during assertion evaluations. See example testscript-search.xml.; (xsd)variable:TestScript.variable>*
< A series of required setup operations before tests are executed.; (xsd)setup:TestScript.setup>?
[]< A test in this script.; (xsd)test:TestScript.test>*
< A series of operations required to clean up after all the tests are executed (successfully or otherwise).; (xsd)teardown:TestScript.teardown>?🔗 An abstract server used in operations within this test script in the destination element. The purpose of this element is to define the profile of a destination element used elsewhere in the script. Test engines could then use the destination-profile mapping to offer a filtered list of test systems that can serve as the receiver for the interaction.TestScript.destination(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Abstract name given to a destination server in this test script. The name is provided as a number starting at 1. A given destination index (e.g. 1) can appear only once in the list (e.g. Destination 1 cannot be specified twice ... once as Form-Manager and again as Form-Processor within the same script as that could get confusing during test configuration).
Different destination indices could play the same actor in the same test script (e.g. You could have two different test systems acting as Form-Manager).
The destination indices provided elsewhere in the test script must be one of these destination indices.; (xsd)index:integer>
< The type of destination profile the test system supports. Must be a "receiver"/"server" profile. Binding: testscript-profile-destination-types (extensible, The type of destination profile the test system supports.); (xsd)profile:Coding>
< The explicit url path of the destination server used in this test script. If provided, the test engine is not expected to prompt for or accept external input of this value.; (xsd)url>?🔗 Fixture in the test script - by reference (uri). All fixtures are required for the test script to execute.TestScript.fixture(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Whether or not to implicitly create the fixture during setup. If true, the fixture is automatically created on each server being tested during setup, therefore no create operation is required for this fixture in the TestScript.setup section.; (xsd)autocreate:boolean>
< Whether or not to implicitly delete the fixture during teardown. If true, the fixture is automatically deleted on each server being tested during teardown, therefore no delete operation is required for this fixture in the TestScript.teardown section.; (xsd)autodelete:boolean>
< Reference to the resource (containing the contents of the resource needed for operations). This is allowed to be a Parameters resource. See the [Resource List](resourcelist.html) for complete list of resource types.; (xsd)resource:Resource*>?🔗 The required capability must exist and are assumed to function correctly on the FHIR server being tested.TestScript.metadata(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< A link to the FHIR specification that this test is covering.; (xsd)link:TestScript.metadata.link>*
[]< Capabilities that must exist and are assumed to function correctly on the FHIR server being tested. When the metadata capabilities section is defined at TestScript.metadata or at TestScript.setup.metadata, and the server's conformance statement does not contain the elements defined in the minimal conformance statement, then all the tests in the TestScript are skipped. When the metadata capabilities section is defined at TestScript.test.metadata and the server's conformance statement does not contain the elements defined in the minimal conformance statement, then only that test is skipped. The "metadata.capabilities.required" and "metadata.capabilities.validated" elements only indicate whether the capabilities are the primary focus of the test script or not. They do not impact the skipping logic. Capabilities whose "metadata.capabilities.validated" flag is true are the primary focus of the test script.; (xsd)capability:TestScript.metadata.capability>+🔗 Capabilities that must exist and are assumed to function correctly on the FHIR server being tested. When the metadata capabilities section is defined at TestScript.metadata or at TestScript.setup.metadata, and the server's conformance statement does not contain the elements defined in the minimal conformance statement, then all the tests in the TestScript are skipped. When the metadata capabilities section is defined at TestScript.test.metadata and the server's conformance statement does not contain the elements defined in the minimal conformance statement, then only that test is skipped. The "metadata.capabilities.required" and "metadata.capabilities.validated" elements only indicate whether the capabilities are the primary focus of the test script or not. They do not impact the skipping logic. Capabilities whose "metadata.capabilities.validated" flag is true are the primary focus of the test script.TestScript.metadata.capability(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Whether or not the test execution will require the given capabilities of the server in order for this test script to execute.; (xsd)required:boolean>
< Whether or not the test execution will validate the given capabilities of the server in order for this test script to execute.; (xsd)validated:boolean>
< Description of the capabilities that this test script is requiring the server to support.; (xsd)description:string>?
[]< Which origin server these requirements apply to.; (xsd)origin:integer>*
< Which server these requirements apply to.; (xsd)destination:integer>?
[]< Links to the FHIR specification that describes this interaction and the resources involved in more detail.; (xsd)link:uri>*
< Minimum capabilities required of server for test script to execute successfully. If server does not meet at a minimum the referenced capability statement, then all tests in this script are skipped. The conformance statement of the server has to contain at a minimum the contents of the reference pointed to by this element.; (xsd)capabilities:CapabilityStatement*>🔗 A link to the FHIR specification that this test is covering.TestScript.metadata.link(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< URL to a particular requirement or feature within the FHIR specification.; (xsd)url:uri>
< Short description of the link.; (xsd)description:string>?🔗 An abstract server used in operations within this test script in the origin element. The purpose of this element is to define the profile of an origin element used elsewhere in the script. Test engines could then use the origin-profile mapping to offer a filtered list of test systems that can serve as the sender for the interaction.TestScript.origin(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Abstract name given to an origin server in this test script. The name is provided as a number starting at 1. A given origin index (e.g. 1) can appear only once in the list (e.g. Origin 1 cannot be specified twice ... once as FormFiller and again as FormProcessor within the same script as that could get confusing during test configuration).
Different origin indices could play the same actor in the same test script (e.g. You could have two different test systems acting as Form-Filler).
The origin indices provided elsewhere in the test script must be one of these origin indices.; (xsd)index:integer>
< The type of origin profile the test system supports. Must be a "sender"/"client" profile. Binding: testscript-profile-origin-types (extensible, The type of origin profile the test system supports.); (xsd)profile:Coding>
< The explicit url path of the origin server used in this test script. If provided, the test engine is not expected to prompt for or accept external input of this value.; (xsd)url>?🔗 The scope indicates a conformance artifact that is tested by the test(s) within this test case and the expectation of the test outcome(s) as well as the intended test phase inclusion.TestScript.scope(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The specific conformance artifact being tested. The canonical reference can be version-specific.; (xsd)artifact:Resource*>
< The expectation of whether the test must pass for the system to be considered conformant with the artifact: required - all tests are expected to pass, optional - all test are expected to pass but non-pass status may be allowed, strict - all tests are expected to pass and warnings are treated as a failure. Binding: testscript-scope-conformance-codes (extensible, The expectation of whether the test must pass for the system to be considered conformant with the artifact.); (xsd)conformance:CodeableConcept>?
< The phase of testing for this artifact: unit - development / implementation phase, integration - internal system to system phase, production - live system to system phase (Note, this may involve pii/phi data). Binding: testscript-scope-phase-codes (extensible, The phase of testing for this artifact.); (xsd)phase:CodeableConcept>?🔗 A series of required setup operations before tests are executed.TestScript.setup(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< Action would contain either an operation or an assertion. An action should contain either an operation or an assertion but not both. It can contain any number of variables.; (xsd)action:TestScript.setup.action>+🔗 Action would contain either an operation or an assertion. An action should contain either an operation or an assertion but not both. It can contain any number of variables.TestScript.setup.action(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The operation to perform.; (xsd)operation:TestScript.setup.action.operation>?
< Evaluates the results of previous operations to determine if the server under test behaves appropriately. In order to evaluate an assertion, the request, response, and results of the most recently executed operation must always be maintained by the test engine.; (xsd)assert:TestScript.setup.action.assert>?🔗 Evaluates the results of previous operations to determine if the server under test behaves appropriately. In order to evaluate an assertion, the request, response, and results of the most recently executed operation must always be maintained by the test engine.TestScript.setup.action.assert(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The label would be used for tracking/logging purposes by test engines. This has no impact on the verification itself.; (xsd)label:string>?
< The description would be used by test engines for tracking and reporting purposes. This has no impact on the verification itself.; (xsd)description:string>?
< The direction to use for the assertion. If the direction is specified as "response" (the default), then the processing of this assert is against the received response message. If the direction is specified as "request", then the processing of this assert is against the sent request message. Binding: assert-direction-codes (required, The direction to use for assertions.); (xsd)direction:code>?
< Id of the source fixture used as the contents to be evaluated by either the "source/expression" or "sourceId/path" definition.; (xsd)compareToSourceId:string>?
< The FHIRPath expression for a specific value to evaluate against the source fixture. When compareToSourceId is defined, either compareToSourceExpression or compareToSourcePath must be defined, but not both. Thefhirpath expression to be evaluated against the expected fixture to compare to. Ignored if "assert.value" is used. The evaluation will be done before the assertion is evaluated.; (xsd)compareToSourceExpression:string>?
< XPath or JSONPath expression to evaluate against the source fixture. When compareToSourceId is defined, either compareToSourceExpression or compareToSourcePath must be defined, but not both. The XPath or JSONPath expression to be evaluated against the expected fixture to compare to. Ignored if "assert.value" is used. The evaluation will be done before the assertion is evaluated.; (xsd)compareToSourcePath:string>?
< The mime-type contents to compare against the request or response message 'Content-Type' header. If this is specified, then test engine shall confirm that the content-type of the last operation's headers is set to this value. If "assert.sourceId" element is specified, then the evaluation will be done against the headers mapped to that sourceId (and not the last operation's headers). If you'd like to have more control over the string, then use 'assert.headerField' instead. Binding: mimetypes (required, BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)); (xsd)contentType:code>?
< The default manual completion outcome applied to this assertion. Manual completion is used to pause the test engine execution and evaluation allowing an external review of the defined assert condition. The defaultManualCompletion defines the default manual completion outcome applied if one of the enumerated values is not applied. Binding: assert-manual-completion-codes (required, The default type of manual completion to use for assertion.); (xsd)defaultManualCompletion:code>?
< The FHIRPath expression to be evaluated against the request or response message contents - HTTP headers and payload. If both "expression" and a "fixtureId" are specified, then the expression will be evaluated against the request or response body mapped to the fixtureId. If "expression" is specified and a "fixtureId" is not, then the expression will be evaluated against the response body of the last operation. Test engines are to store the request and response body and headers of the last operation at all times for subsequent assertions.
The FHIRPath expression can be evaluated as either a path to a specific value or as a boolean expression against the given FHIR resource. When the FHIRPath is a boolean expression, the assert.value element is not used. See [Testing FHIR Use Expressions](testing.html#expressions).; (xsd)expression:string>?
< The HTTP header field name e.g. 'Location'. If "headerField" is specified then "value" must be specified. If "sourceId" is not specified, then "headerField" will be evaluated against the last operation's response headers. Test engines are to keep track of the last operation's response body and response headers.; (xsd)headerField:string>?
< The ID of a fixture. Asserts that the response contains at a minimum the fixture specified by minimumId. Asserts that the response contains all the element/content in another fixture pointed to by minimumId. This can be a statically defined fixture or one that is dynamically set via responseId.
See [Testing FHIR Use minimumId](testing.html##minimumId) for a more complete description of the test engine's comparison logic.; (xsd)minimumId:string>?
< Whether or not the test execution performs validation on the bundle navigation links. Asserts that the Bundle contains first, last, and next links.; (xsd)navigationLinks:boolean>?
< The operator type defines the conditional behavior of the assert. Operators are useful for both positive and negative testing. If operator is not specified, then the default conditional behavior is implemented as defined in [Testing FHIR Assertions](testing.html#assertion-table). Binding: assert-operator-codes (required, The type of operator to use for assertions.); (xsd)operator:code>?
< The XPath or JSONPath expression to be evaluated against the fixture representing the response received from server. If both "path" and a "fixtureId" are specified, then the path will be evaluated against the request or response body mapped to the fixtureId. If "path" is specified and a "fixtureId" is not, then the path will be evaluated against the response body of the last operation. Test engines are to store the request and response body and headers of the last operation at all times for subsequent assertions.; (xsd)path:string>?
< The request method or HTTP operation code to compare against that used by the client system under test. If "requestMethod" is specified then it will be used in place of "value". The "requestMethod" will evaluate against the last operation's request HTTP operation. Binding: http-operations (required, The allowable request method or HTTP operation codes.); (xsd)requestMethod:code>?
< The value to use in a comparison against the request URL path string. If "requestURL" is specified then it will be used in place of "value". The "requestURL" will evaluate against the last operation's full request URL path string.; (xsd)requestURL:string>?
< The type of the resource. See the [resource list](resourcelist.html). This will be expected resource type in response body e.g. in read, vread, search, etc. See the [Resource List](resourcelist.html) for complete list of resource types; e.g. . Binding: concrete-fhir-types (extensible, A list of all the concrete types defined in this version of the FHIR specification - Data Types and Resource Types.); (xsd)resource:uri>?
< continue | switchingProtocols | okay | created | accepted | nonAuthoritativeInformation | noContent | resetContent | partialContent | multipleChoices | movedPermanently | found | seeOther | notModified | useProxy | temporaryRedirect | permanentRedirect | badRequest | unauthorized | paymentRequired | forbidden | notFound | methodNotAllowed | notAcceptable | proxyAuthenticationRequired | requestTimeout | conflict | gone | lengthRequired | preconditionFailed | contentTooLarge | uriTooLong | unsupportedMediaType | rangeNotSatisfiable | expectationFailed | misdirectedRequest | unprocessableContent | upgradeRequired | internalServerError | notImplemented | badGateway | serviceUnavailable | gatewayTimeout | httpVersionNotSupported. This is a shorter way of achieving similar verifications via "assert.responseCode". If you need more control, then use "assert.responseCode" e.g. . Binding: assert-response-code-types (required, The response code to expect in the response.); (xsd)response:code>?
< The value of the HTTP response code to be tested. To be used with "operator" attribute value. Asserts that the response code equals this value if "operator" is not specified. If the operator is "in" or "notIn" then the responseCode would be a comma-separated list of values e.g. "200,201". Otherwise, it's expected to be a numeric value. If "fixture" is not specified, then the "responseBodyId" value of the last operation is assumed.; (xsd)responseCode:string>?
< Fixture to evaluate the XPath/JSONPath expression or the headerField against. This can be a statically defined fixture (at the top of the testscript) or a dynamically set fixture created by responseId of the action.operation element.; (xsd)sourceId:id>?
< Whether or not the current test execution will stop on failure for this assert. If this element is specified and it is true, then assertion failures should not stop the current test execution from proceeding.; (xsd)stopTestOnFail:boolean>
< The ID of the Profile to validate against. The ID of a Profile fixture. Asserts that the response is valid according to the Profile specified by validateProfileId.; (xsd)validateProfileId:id>?
< The value to compare to. The string-representation of a number, string, or boolean that is expected. Test engines do have to look for placeholders (${}) and replace the variable placeholders with the variable values at runtime before comparing this value to the actual value.; (xsd)value:string>?
< Whether or not the test execution will produce a warning only on error for this assert. If this element is specified and it is true, then assertion failures can be logged by test engine but should not stop the test script execution from proceeding. There are likely cases where the spec is not clear on what should happen. If the spec says something is optional (maybe a response header for example), but a server doesn’t do it, we could choose to issue a warning.; (xsd)warningOnly:boolean>
[]< Links or references providing traceability to the testing requirements for this assert. TestScript and TestReport instances are typically (and expected to be) based on known, defined test requirements and documentation. These links provide traceability from the executable/executed TestScript and TestReport tests to these requirements.; (xsd)requirement:TestScript.setup.action.assert.requirement>*🔗 Links or references providing traceability to the testing requirements for this assert. TestScript and TestReport instances are typically (and expected to be) based on known, defined test requirements and documentation. These links provide traceability from the executable/executed TestScript and TestReport tests to these requirements.TestScript.setup.action.assert.requirement(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Link or reference providing traceability to the testing requirement for this test.; (xsd)link:(<Requirements>
|<uri>)>?🔗 The operation to perform.TestScript.setup.action.operation(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Server interaction or operation type. See the list of [server interactions](http.html). Binding: testscript-operation-codes (extensible, FHIR Operation Code Types); (xsd)type:Coding>?
< The type of the FHIR resource. See the [resource list](resourcelist.html). Data type of uri is needed when non-HL7 artifacts are identified. If "url" element is specified, then "targetId", "params", and "resource" elements will be ignored as "url" element will have everything needed for constructing the request url. If "params" element is specified, then "targetId" element is ignored. For FHIR operations that require a resource (e.g. "read" and "vread" operations), the "resource" element must be specified when "params" element is specified. If "url" and "params" elements are absent, then the request url will be constructed from "targetId" fixture if present. For "read" operation, the resource and id values will be extracted from "targetId" fixture and used to construct the url. For "vread" and "history" operations, the versionId value will also be used. Binding: concrete-fhir-types (extensible, A list of all the concrete types defined in this version of the FHIR specification - Data Types and Resource Types.); (xsd)resource:uri>?
< The label would be used for tracking/logging purposes by test engines. This has no impact on the verification itself.; (xsd)label:string>?
< The description would be used by test engines for tracking and reporting purposes. This has no impact on the verification itself.; (xsd)description:string>?
< The mime-type to use for RESTful operation in the 'Accept' header. If this is specified, then test engine shall set the 'Accept' header to the corresponding value. If you'd like to explicitly set the 'Accept' to some other value then use the 'requestHeader' element. Binding: mimetypes (required, BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)); (xsd)accept:code>?
< The mime-type to use for RESTful operation in the 'Content-Type' header. If this is specified, then test engine shall set the 'Content-Type' header to the corresponding value. If you'd like to explicitly set the 'Content-Type' to some other value then use the 'requestHeader' element. Binding: mimetypes (required, BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)); (xsd)contentType:code>?
< The server where the request message is destined for. Must be one of the server numbers listed in TestScript.destination section. If multiple TestScript.destination elements are defined and operation.destination is undefined, test engine will report an error as it cannot determine what destination to use for the exchange.; (xsd)destination:integer>?
< Whether or not to implicitly send the request url in encoded format. The default is true to match the standard RESTful client behavior. Set to false when communicating with a server that does not support encoded url paths.; (xsd)encodeRequestUrl:boolean>
< The HTTP method the test engine MUST use for this operation regardless of any other operation details. The primary purpose of the explicit HTTP method is support of HTTP POST method invocation of the FHIR search. Other uses will include support of negative testing. Binding: http-operations (required, The allowable request method or HTTP operation codes.); (xsd)method:code>?
< The server where the request message originates from. Must be one of the server numbers listed in TestScript.origin section. If absent, test engine will send the message. When present, test engine will not send the request message but will wait for the request message to be sent from this origin server.; (xsd)origin:integer>?
< Path plus parameters after [type]. Used to set parts of the request URL explicitly. If "url" element is specified, then "targetId", "params", and "resource" elements will be ignored as "url" element will have everything needed for constructing the request url. If "params" element is specified, then "targetId" element is ignored. For FHIR operations that require a resource (e.g. "read" and "vread" operations), the "resource" element must be specified when "params" element is specified. If "url" and "params" elements are absent, then the request url will be constructed from "targetId" fixture if present. For "read" operation, the resource and id values will be extracted from "targetId" fixture and used to construct the url. For "vread" and "history" operations, the versionId value will also be used. Test engines would append whatever is specified for "params" to the URL after the resource type without tampering with the string (beyond encoding the URL for HTTP). The "params" element does not correspond exactly to "search parameters". Nor is it the "path". It corresponds to the part of the URL that comes after the [type] (when "resource" element is specified); e.g. It corresponds to "/[id]/_history/[vid] {?_format=[mime-type]}" in the following operation: GET [base]/[type]/[id]/_history/[vid] {?_format=[mime-type]} Test engines do have to look for placeholders (${}) and replace the variable placeholders with the variable values at runtime before sending the request.; (xsd)params:string>?
[]< Header elements would be used to set HTTP headers. This gives control to test-script writers to set headers explicitly based on test requirements. It will allow for testing using: - "If-Modified-Since" and "If-None-Match" headers. ["If-Match" header](http.html#2.1.0.5.1). See [Conditional Create using "If-None-Exist"](http.html#2.1.0.11). See [Invalid "Content-Type" header](http.html#2.1.0.13.1) for negative testing. - etc.; (xsd)requestHeader:TestScript.setup.action.operation.requestHeader>*
< The fixture id (maybe new) to map to the request. If a requestId is supplied, then the resulting request (both headers and body) is mapped to the fixture ID (which may be entirely new and previously undeclared) designated by "requestId". If requestId is not specified, it is the test engine's responsibility to store the request and use it as the requestId in subsequent assertions when assertion path and/or headerField is specified, direction is equal to request, and the requestId in not specified.; (xsd)requestId:id>?
< The fixture id (maybe new) to map to the response. If a responseId is supplied, and the server responds, then the resulting response (both headers and body) is mapped to the fixture ID (which may be entirely new and previously undeclared) designated by "responseId". If responseId is not specified, it is the test engine's responsibility to store the response and use it as the responseId in subsequent assertions when assertion path and/or headerField is specified and the responseId is not specified.; (xsd)responseId:id>?
< The id of the fixture used as the body of a PUT or POST request.; (xsd)sourceId:id>?
< Id of fixture used for extracting the [id], [type], and [vid] for GET requests. If "url" element is specified, then "targetId", "params", and "resource" elements will be ignored as "url" element will have everything needed for constructing the request url. If "params" element is specified, then "targetId" element is ignored. For FHIR operations that require a resource (e.g. "read" and "vread" operations), the "resource" element must be specified when "params" element is specified. If "url" and "params" elements are absent, then the request url will be constructed from "targetId" fixture if present. For "read" operation, the resource and id values will be extracted from "targetId" fixture and used to construct the url. For "vread" and "history" operations, the versionId value will also be used.; (xsd)targetId:id>?
< Complete request URL. Used to set the request URL explicitly. If "url" element is defined, then "targetId", "resource", and "params" elements will be ignored. Test engines would use whatever is specified in "url" without tampering with the string (beyond encoding the URL for HTTP). Test engines do have to look for placeholders (${}) and replace the variable placeholders with the variable values at runtime before sending the request.; (xsd)url:string>?🔗 Header elements would be used to set HTTP headers. This gives control to test-script writers to set headers explicitly based on test requirements. It will allow for testing using: - "If-Modified-Since" and "If-None-Match" headers. ["If-Match" header](http.html#2.1.0.5.1). See [Conditional Create using "If-None-Exist"](http.html#2.1.0.11). See [Invalid "Content-Type" header](http.html#2.1.0.13.1) for negative testing. - etc.TestScript.setup.action.operation.requestHeader(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The HTTP header field e.g. "Accept". If header element is specified, then field is required.; (xsd)field:string>
< The value of the header e.g. "application/fhir+xml". If header element is specified, then value is required. No conversions will be done by the test engine e.g. "xml" to "application/fhir+xml". The values will be set in HTTP headers "as-is". Test engines do have to look for placeholders (${}) and replace the variable placeholders with the variable values at runtime before sending the request.; (xsd)value:string>🔗 A series of operations required to clean up after all the tests are executed (successfully or otherwise).TestScript.teardown(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< The teardown action will only contain an operation. An action should contain either an operation or an assertion but not both. It can contain any number of variables.; (xsd)action:TestScript.teardown.action>+🔗 The teardown action will only contain an operation. An action should contain either an operation or an assertion but not both. It can contain any number of variables.TestScript.teardown.action(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< An operation would involve a REST request to a server.; (xsd)operation:TestScript.setup.action.operation>🔗 A test in this script.TestScript.test(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The name of this test used for tracking/logging purposes by test engines.; (xsd)name:string>?
< A short description of the test used by test engines for tracking and reporting purposes.; (xsd)description:string>?
[]< Action would contain either an operation or an assertion. An action should contain either an operation or an assertion but not both. It can contain any number of variables.; (xsd)action:TestScript.test.action>+🔗 Action would contain either an operation or an assertion. An action should contain either an operation or an assertion but not both. It can contain any number of variables.TestScript.test.action(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< An operation would involve a REST request to a server.; (xsd)operation:TestScript.setup.action.operation>?
< Evaluates the results of previous operations to determine if the server under test behaves appropriately. In order to evaluate an assertion, the request, response, and results of the most recently executed operation must always be maintained by the test engine.; (xsd)assert:TestScript.setup.action.assert>?🔗 Variable is set based either on element value in response body or on header field value in the response headers. Variables would be set based either on XPath/JSONPath expressions against fixtures (static and response), or headerField evaluations against response headers. If variable evaluates to nodelist or anything other than a primitive value, then test engine would report an error. Variables would be used to perform clean replacements in "operation.params", "operation.requestHeader.value", and "operation.url" element values during operation calls and in "assert.value" during assertion evaluations. This limits the places that test engines would need to look for placeholders "${}". Variables are scoped to the whole script. They are NOT evaluated at declaration. They are evaluated by test engine when used for substitutions in "operation.params", "operation.requestHeader.value", and "operation.url" element values during operation calls and in "assert.value" during assertion evaluations. See example testscript-search.xml.TestScript.variable(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Descriptive name for this variable. Placeholders would contain the variable name wrapped in ${} in "operation.params", "operation.requestHeader.value", and "operation.url" elements. These placeholders would need to be replaced by the variable value before the operation is executed.; (xsd)name:string>
< A default, hard-coded, or user-defined value for this variable. The purpose of this element is to allow for a pre-defined value that can be used as a default or as an override value. Test engines can optionally use this as a placeholder for user-defined execution time values.; (xsd)defaultValue:string>?
< A free text natural language description of the variable and its purpose.; (xsd)description:string>?
< The FHIRPath expression for a specific value to evaluate against the fixture body. When variables are defined, only one of either expression, headerField or path must be specified. If headerField is defined, then the variable will be evaluated against the headers that sourceId is pointing to. If expression or path is defined, then the variable will be evaluated against the fixture body that sourceId is pointing to. It is an error to define any combination of expression, headerField and path.; (xsd)expression:string>?
< Will be used to grab the HTTP header field value from the headers that sourceId is pointing to. If headerField is defined, then the variable will be evaluated against the headers that sourceId is pointing to. If path is defined, then the variable will be evaluated against the fixture body that sourceId is pointing to. It is an error to define both headerField and path.; (xsd)headerField:string>?
< Displayable text string with hint help information to the user when entering a default value.; (xsd)hint:string>?
< XPath or JSONPath to evaluate against the fixture body. When variables are defined, only one of either expression, headerField or path must be specified. If headerField is defined, then the variable will be evaluated against the headers that sourceId is pointing to. If expression or path is defined, then the variable will be evaluated against the fixture body that sourceId is pointing to. It is an error to define any combination of expression, headerField and path.; (xsd)path:string>?
< Fixture to evaluate the XPath/JSONPath expression or the headerField against within this variable. This can be a statically defined fixture (at the top of the TestScript) or a dynamically set fixture created by responseId of the `action.operation` element.; (xsd)sourceId:id>?🔗 A time during the day, with no date specifiedtime(xsd)(doc)=
<#base:PrimitiveType>
< unique id for the element within a resource (for internal references); (xsd)id:string>?
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< The actual value; (xsd)value:time>?🔗 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(xsd)(doc)=
<#base:BackboneType>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< Identifies specific times when the event occurs.; (xsd)event:dateTime>*
< A set of rules that describe when the event is scheduled.; (xsd)repeat:Timing.repeat>?
< 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). Binding: timing-abbreviation (preferred, Code for a known / defined timing pattern.); (xsd)code:CodeableConcept>?🔗 A set of rules that describe when the event is scheduled.Timing.repeat(xsd)(doc)=
<#base:Element>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< 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.; (xsd)bounds:(<Duration>
|<Period>
|<Range>)>?
< 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.; (xsd)count:positiveInt>?
< If present, indicates that the count is a range - so to perform the action between [count] and [countMax] times.; (xsd)countMax:positiveInt>?
< 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).; (xsd)duration:decimal>?
< 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).; (xsd)durationMax:decimal>?
< The units of time for the duration, in UCUM units
Normal practice is to use the 'mo' code as a calendar month when calculating the next occurrence. Binding: units-of-time (required, A unit of time (units from UCUM).); (xsd)durationUnit:code>?
< 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.; (xsd)frequency:positiveInt>?
< If present, indicates that the frequency is a range - so to repeat between [frequency] and [frequencyMax] times within the period or period range.; (xsd)frequencyMax:positiveInt>?
< 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.; (xsd)period:decimal>?
< 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.; (xsd)periodMax:decimal>?
< The units of time for the period in UCUM units
Normal practice is to use the 'mo' code as a calendar month when calculating the next occurrence. Binding: units-of-time (required, A unit of time (units from UCUM).); (xsd)periodUnit:code>?
[]< 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. Binding: days-of-week (required, ); (xsd)dayOfWeek:code>*
[]< Specified time of day for action to take place. When time of day is specified, it is inferred that the action happens every day (as filtered by dayofWeek) on the specified times. If there's a timeOfDay, there cannot be a when, or vice versa.; (xsd)timeOfDay:time>*
[]< 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. Binding: event-timing (required, Real-world event relating to the schedule.); (xsd)when:code>*
< 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.; (xsd)offset:unsignedInt>?🔗 A container for a collection of resources.transaction-bundle(xsd)(doc)=
<#base:Bundle>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< A persistent identifier for the bundle that won't change as a bundle is copied from server to server. Persistent identity generally only matters for batches of type Document, Message, and Collection. It would not normally be populated for search and history results and servers ignore Bundle.identifier when processing batches and transactions. For Documents the .identifier SHALL be populated such that the .identifier is globally unique.; (xsd)identifier:Identifier>?
< Indicates the purpose of this bundle - how it is intended to be used. It's possible to use a bundle for other purposes (e.g. a document can be accepted as a transaction). This is primarily defined so that there can be specific rules for some of the bundle types. Binding: bundle-type (required, Indicates the purpose of a bundle - how it is intended to be used.); (xsd)type:code>
< The date/time that the bundle was assembled - i.e. when the resources were placed in the bundle. For many bundles, the timestamp is equal to .meta.lastUpdated, because they are not stored (e.g. search results). When a bundle is placed in a persistent store, .meta.lastUpdated will be usually be changed by the server. When the bundle is a message, a middleware agent altering the message (even if not stored) SHOULD update .meta.lastUpdated. .timestamp is used to track the original time of the Bundle, and SHOULD be populated.
Usage:
* document : the date the document was created. Note: the composition may predate the document, or be associated with multiple documents. The date of the composition - the authoring time - may be earlier than the document assembly time
* message : the date that the content of the message was assembled. This date is not changed by middleware engines unless they add additional data that changes the meaning of the time of the message
* history : the date that the history was assembled. This time would be used as the _since time to ask for subsequent updates
* searchset : the time that the search set was assembled. Note that different pages MAY have different timestamps but need not. Having different timestamps does not imply that subsequent pages will represent or include changes made since the initial query
* transaction | transaction-response | batch | batch-response | collection : no particular assigned meaning
The timestamp value should be greater than the lastUpdated and other timestamps in the resources in the bundle, and it should be equal or earlier than the .meta.lastUpdated on the Bundle itself.; (xsd)timestamp:instant>?
< If a set of search matches, this is the (potentially estimated) total number of entries of type 'match' across all pages in the search. It does not include search.mode = 'include' or 'outcome' entries and it does not provide a count of the number of entries in the Bundle. Only used if the bundle is a search result set. The total does not include resources such as OperationOutcome and included resources, only the total number of matching resources.; (xsd)total:unsignedInt>{0,0}
[]< A series of links that provide context to this bundle. Both Bundle.link and Bundle.entry.link are defined to support providing additional context when Bundles are used (e.g. [HATEOAS](http://en.wikipedia.org/wiki/HATEOAS)).
Bundle.entry.link corresponds to links found in the HTTP header if the resource in the entry was [read](http.html#read) directly.
This specification defines some specific uses of Bundle.link for [searching](search.html#conformance) and [paging](http.html#paging), but no specific uses for Bundle.entry.link, and no defined function in a transaction - the meaning is implementation specific. The behavior of navigation link types (next/prev/first/last) are well defined for searchset and history Bundles but are not currently defined for other types. Implementers who choose to use such link relationships for other bundle types will need to negotiate behavior with their interoperability partners.; (xsd)link:transaction-bundle.link>*
[]< An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).; (xsd)entry:transaction-bundle.entry>*
< Digital Signature - base64 encoded. XML-DSig or a JWS. The signature could be created by the "author" of the bundle or by the originating device. Requirements around inclusion of a signature, verification of signatures and treatment of signed/non-signed bundles is implementation-environment specific.; (xsd)signature:Signature>?
< Captures issues and warnings that relate to the construction of the Bundle and the content within it. Usage notes: These issues and warnings must apply to the Bundle as a whole, not to individual entries.Messages relating to the processing of individual entries (e.g. in a batch or transaction) SHALL be reported in the entry.response.outcome for that entry. If there are errors that arise in the creation of the Bundle, then that should be handled by an OperationOutcome being returned instead of the Bundle.; (xsd)issues:OperationOutcome>?
[]< An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).; (xsd)put:transaction-bundle.put>*
[]< An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).; (xsd)post:transaction-bundle.post>*
[]< An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).; (xsd)get:transaction-bundle.get>*
[]< An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).; (xsd)delete:transaction-bundle.delete>*
[]< An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).; (xsd)patch:transaction-bundle.patch>*
[]< An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).; (xsd)head:transaction-bundle.head>*🔗 An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).transaction-bundle.delete(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< A series of links that provide context to this entry.; (xsd)link:Bundle.link>*
< The Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when:
* invoking a create
* invoking or responding to an operation where the body is not a single identified resource
* invoking or returning the results of a search or history operation. fullUrl might not be [unique in the context of a resource](bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](references.html), the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the [regex](references.html#regex), then the 'id' portion of the fullUrl SHALL end with the Resource.id.
Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).; (xsd)fullUrl:uri>
< The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. This is allowed to be a Parameters resource if and only if it is referenced by something else within the Bundle that provides context/meaning.; (xsd)resource:Resource>{0,0}
< Information about the search process that lead to the creation of this entry.; (xsd)search:transaction-bundle.delete.search>{0,0}
< Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.; (xsd)request:transaction-bundle.delete.request>
< Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.; (xsd)response:transaction-bundle.delete.response>{0,0}🔗 Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.transaction-bundle.delete.request(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred. Binding: http-verb (required, HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details.); (xsd)method:code>
< The URL for this entry, relative to the root (the address to which the request is posted). E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]".; (xsd)url:uri>
< If the ETag values match, return a 304 Not Modified status. See the API documentation for ["Conditional Read"](http.html#cread).; (xsd)ifNoneMatch:string>?
< Only perform the operation if the last updated date matches. See the API documentation for ["Conditional Read"](http.html#cread).; (xsd)ifModifiedSince:instant>?
< Only perform the operation if the Etag value matches. For more information, see the API section ["Managing Resource Contention"](http.html#concurrency).; (xsd)ifMatch:string>?
< Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for ["Conditional Create"](http.html#ccreate). This is just the query portion of the URL - what follows the "?" (not including the "?").; (xsd)ifNoneExist:string>?🔗 Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.transaction-bundle.delete.response(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.; (xsd)status:string>
< The location header created by processing this operation, populated if the operation returns a location.; (xsd)location:uri>?
< The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)). Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.; (xsd)etag:string>?
< The date/time that the resource was modified on the server. This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.; (xsd)lastModified:instant>?
< An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction. For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.
This outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.; (xsd)outcome:Resource>?🔗 Information about the search process that lead to the creation of this entry.transaction-bundle.delete.search(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence. Binding: search-entry-mode (required, Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.); (xsd)mode:code>?
< When searching, the server's search ranking score for the entry. Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.
See [Patient Match](patient-operation-match.html) for the EMPI search which relates to this element.; (xsd)score:decimal>?🔗 An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).transaction-bundle.entry(xsd)(doc)=
<#base:Bundle.entry>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< A series of links that provide context to this entry.; (xsd)link:Bundle.link>*
< The Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when:
* invoking a create
* invoking or responding to an operation where the body is not a single identified resource
* invoking or returning the results of a search or history operation. fullUrl might not be [unique in the context of a resource](bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](references.html), the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the [regex](references.html#regex), then the 'id' portion of the fullUrl SHALL end with the Resource.id.
Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).; (xsd)fullUrl:uri>?
< The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. This is allowed to be a Parameters resource if and only if it is referenced by something else within the Bundle that provides context/meaning.; (xsd)resource:Resource>?
< Information about the search process that lead to the creation of this entry.; (xsd)search:transaction-bundle.entry.search>?
< Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.; (xsd)request:transaction-bundle.entry.request>?
< Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.; (xsd)response:transaction-bundle.entry.response>?🔗 Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.transaction-bundle.entry.request(xsd)(doc)=
<#base:Bundle.entry.request>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred. Binding: http-verb (required, HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details.); (xsd)method:code>
< The URL for this entry, relative to the root (the address to which the request is posted). E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]".; (xsd)url:uri>
< If the ETag values match, return a 304 Not Modified status. See the API documentation for ["Conditional Read"](http.html#cread).; (xsd)ifNoneMatch:string>?
< Only perform the operation if the last updated date matches. See the API documentation for ["Conditional Read"](http.html#cread).; (xsd)ifModifiedSince:instant>?
< Only perform the operation if the Etag value matches. For more information, see the API section ["Managing Resource Contention"](http.html#concurrency).; (xsd)ifMatch:string>?
< Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for ["Conditional Create"](http.html#ccreate). This is just the query portion of the URL - what follows the "?" (not including the "?").; (xsd)ifNoneExist:string>?🔗 Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.transaction-bundle.entry.response(xsd)(doc)=
<#base:Bundle.entry.response>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.; (xsd)status:string>
< The location header created by processing this operation, populated if the operation returns a location.; (xsd)location:uri>?
< The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)). Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.; (xsd)etag:string>?
< The date/time that the resource was modified on the server. This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.; (xsd)lastModified:instant>?
< An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction. For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.
This outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.; (xsd)outcome:Resource>?🔗 Information about the search process that lead to the creation of this entry.transaction-bundle.entry.search(xsd)(doc)=
<#base:Bundle.entry.search>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence. Binding: search-entry-mode (required, Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.); (xsd)mode:code>?
< When searching, the server's search ranking score for the entry. Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.
See [Patient Match](patient-operation-match.html) for the EMPI search which relates to this element.; (xsd)score:decimal>?🔗 An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).transaction-bundle.get(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< A series of links that provide context to this entry.; (xsd)link:Bundle.link>*
< The Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when:
* invoking a create
* invoking or responding to an operation where the body is not a single identified resource
* invoking or returning the results of a search or history operation. fullUrl might not be [unique in the context of a resource](bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](references.html), the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the [regex](references.html#regex), then the 'id' portion of the fullUrl SHALL end with the Resource.id.
Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).; (xsd)fullUrl:uri>
< The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. This is allowed to be a Parameters resource if and only if it is referenced by something else within the Bundle that provides context/meaning.; (xsd)resource:Resource>{0,0}
< Information about the search process that lead to the creation of this entry.; (xsd)search:transaction-bundle.get.search>{0,0}
< Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.; (xsd)request:transaction-bundle.get.request>
< Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.; (xsd)response:transaction-bundle.get.response>{0,0}🔗 Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.transaction-bundle.get.request(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred. Binding: http-verb (required, HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details.); (xsd)method:code>
< The URL for this entry, relative to the root (the address to which the request is posted). E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]".; (xsd)url:uri>
< If the ETag values match, return a 304 Not Modified status. See the API documentation for ["Conditional Read"](http.html#cread).; (xsd)ifNoneMatch:string>?
< Only perform the operation if the last updated date matches. See the API documentation for ["Conditional Read"](http.html#cread).; (xsd)ifModifiedSince:instant>?
< Only perform the operation if the Etag value matches. For more information, see the API section ["Managing Resource Contention"](http.html#concurrency).; (xsd)ifMatch:string>?
< Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for ["Conditional Create"](http.html#ccreate). This is just the query portion of the URL - what follows the "?" (not including the "?").; (xsd)ifNoneExist:string>?🔗 Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.transaction-bundle.get.response(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.; (xsd)status:string>
< The location header created by processing this operation, populated if the operation returns a location.; (xsd)location:uri>?
< The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)). Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.; (xsd)etag:string>?
< The date/time that the resource was modified on the server. This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.; (xsd)lastModified:instant>?
< An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction. For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.
This outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.; (xsd)outcome:Resource>?🔗 Information about the search process that lead to the creation of this entry.transaction-bundle.get.search(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence. Binding: search-entry-mode (required, Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.); (xsd)mode:code>?
< When searching, the server's search ranking score for the entry. Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.
See [Patient Match](patient-operation-match.html) for the EMPI search which relates to this element.; (xsd)score:decimal>?🔗 An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).transaction-bundle.head(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< A series of links that provide context to this entry.; (xsd)link:Bundle.link>*
< The Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when:
* invoking a create
* invoking or responding to an operation where the body is not a single identified resource
* invoking or returning the results of a search or history operation. fullUrl might not be [unique in the context of a resource](bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](references.html), the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the [regex](references.html#regex), then the 'id' portion of the fullUrl SHALL end with the Resource.id.
Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).; (xsd)fullUrl:uri>
< The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. This is allowed to be a Parameters resource if and only if it is referenced by something else within the Bundle that provides context/meaning.; (xsd)resource:Resource>{0,0}
< Information about the search process that lead to the creation of this entry.; (xsd)search:transaction-bundle.head.search>{0,0}
< Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.; (xsd)request:transaction-bundle.head.request>
< Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.; (xsd)response:transaction-bundle.head.response>{0,0}🔗 Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.transaction-bundle.head.request(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred. Binding: http-verb (required, HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details.); (xsd)method:code>
< The URL for this entry, relative to the root (the address to which the request is posted). E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]".; (xsd)url:uri>
< If the ETag values match, return a 304 Not Modified status. See the API documentation for ["Conditional Read"](http.html#cread).; (xsd)ifNoneMatch:string>?
< Only perform the operation if the last updated date matches. See the API documentation for ["Conditional Read"](http.html#cread).; (xsd)ifModifiedSince:instant>?
< Only perform the operation if the Etag value matches. For more information, see the API section ["Managing Resource Contention"](http.html#concurrency).; (xsd)ifMatch:string>?
< Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for ["Conditional Create"](http.html#ccreate). This is just the query portion of the URL - what follows the "?" (not including the "?").; (xsd)ifNoneExist:string>?🔗 Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.transaction-bundle.head.response(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.; (xsd)status:string>
< The location header created by processing this operation, populated if the operation returns a location.; (xsd)location:uri>?
< The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)). Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.; (xsd)etag:string>?
< The date/time that the resource was modified on the server. This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.; (xsd)lastModified:instant>?
< An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction. For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.
This outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.; (xsd)outcome:Resource>?🔗 Information about the search process that lead to the creation of this entry.transaction-bundle.head.search(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence. Binding: search-entry-mode (required, Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.); (xsd)mode:code>?
< When searching, the server's search ranking score for the entry. Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.
See [Patient Match](patient-operation-match.html) for the EMPI search which relates to this element.; (xsd)score:decimal>?🔗 A series of links that provide context to this bundle. Both Bundle.link and Bundle.entry.link are defined to support providing additional context when Bundles are used (e.g. [HATEOAS](http://en.wikipedia.org/wiki/HATEOAS)).
Bundle.entry.link corresponds to links found in the HTTP header if the resource in the entry was [read](http.html#read) directly.
This specification defines some specific uses of Bundle.link for [searching](search.html#conformance) and [paging](http.html#paging), but no specific uses for Bundle.entry.link, and no defined function in a transaction - the meaning is implementation specific. The behavior of navigation link types (next/prev/first/last) are well defined for searchset and history Bundles but are not currently defined for other types. Implementers who choose to use such link relationships for other bundle types will need to negotiate behavior with their interoperability partners.transaction-bundle.link(xsd)(doc)=
<#base:Bundle.link>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A name which details the functional use for this link - see [http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1](http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1). Binding: iana-link-relations (required, ); (xsd)relation:code>
< The reference details for the link.; (xsd)url:uri>🔗 An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).transaction-bundle.patch(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< A series of links that provide context to this entry.; (xsd)link:Bundle.link>*
< The Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when:
* invoking a create
* invoking or responding to an operation where the body is not a single identified resource
* invoking or returning the results of a search or history operation. fullUrl might not be [unique in the context of a resource](bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](references.html), the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the [regex](references.html#regex), then the 'id' portion of the fullUrl SHALL end with the Resource.id.
Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).; (xsd)fullUrl:uri>
< The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. This is allowed to be a Parameters resource if and only if it is referenced by something else within the Bundle that provides context/meaning.; (xsd)resource:Resource>
< Information about the search process that lead to the creation of this entry.; (xsd)search:transaction-bundle.patch.search>{0,0}
< Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.; (xsd)request:transaction-bundle.patch.request>
< Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.; (xsd)response:transaction-bundle.patch.response>{0,0}🔗 Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.transaction-bundle.patch.request(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred. Binding: http-verb (required, HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details.); (xsd)method:code>
< The URL for this entry, relative to the root (the address to which the request is posted). E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]".; (xsd)url:uri>
< If the ETag values match, return a 304 Not Modified status. See the API documentation for ["Conditional Read"](http.html#cread).; (xsd)ifNoneMatch:string>?
< Only perform the operation if the last updated date matches. See the API documentation for ["Conditional Read"](http.html#cread).; (xsd)ifModifiedSince:instant>?
< Only perform the operation if the Etag value matches. For more information, see the API section ["Managing Resource Contention"](http.html#concurrency).; (xsd)ifMatch:string>?
< Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for ["Conditional Create"](http.html#ccreate). This is just the query portion of the URL - what follows the "?" (not including the "?").; (xsd)ifNoneExist:string>?🔗 Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.transaction-bundle.patch.response(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.; (xsd)status:string>
< The location header created by processing this operation, populated if the operation returns a location.; (xsd)location:uri>?
< The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)). Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.; (xsd)etag:string>?
< The date/time that the resource was modified on the server. This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.; (xsd)lastModified:instant>?
< An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction. For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.
This outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.; (xsd)outcome:Resource>?🔗 Information about the search process that lead to the creation of this entry.transaction-bundle.patch.search(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence. Binding: search-entry-mode (required, Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.); (xsd)mode:code>?
< When searching, the server's search ranking score for the entry. Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.
See [Patient Match](patient-operation-match.html) for the EMPI search which relates to this element.; (xsd)score:decimal>?🔗 An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).transaction-bundle.post(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< A series of links that provide context to this entry.; (xsd)link:Bundle.link>*
< The Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when:
* invoking a create
* invoking or responding to an operation where the body is not a single identified resource
* invoking or returning the results of a search or history operation. fullUrl might not be [unique in the context of a resource](bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](references.html), the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the [regex](references.html#regex), then the 'id' portion of the fullUrl SHALL end with the Resource.id.
Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).; (xsd)fullUrl:uri>?
< The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. This is allowed to be a Parameters resource if and only if it is referenced by something else within the Bundle that provides context/meaning.; (xsd)resource:Resource>
< Information about the search process that lead to the creation of this entry.; (xsd)search:transaction-bundle.post.search>{0,0}
< Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.; (xsd)request:transaction-bundle.post.request>
< Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.; (xsd)response:transaction-bundle.post.response>{0,0}🔗 Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.transaction-bundle.post.request(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred. Binding: http-verb (required, HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details.); (xsd)method:code>
< The URL for this entry, relative to the root (the address to which the request is posted). E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]".; (xsd)url:uri>
< If the ETag values match, return a 304 Not Modified status. See the API documentation for ["Conditional Read"](http.html#cread).; (xsd)ifNoneMatch:string>?
< Only perform the operation if the last updated date matches. See the API documentation for ["Conditional Read"](http.html#cread).; (xsd)ifModifiedSince:instant>?
< Only perform the operation if the Etag value matches. For more information, see the API section ["Managing Resource Contention"](http.html#concurrency).; (xsd)ifMatch:string>?
< Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for ["Conditional Create"](http.html#ccreate). This is just the query portion of the URL - what follows the "?" (not including the "?").; (xsd)ifNoneExist:string>?🔗 Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.transaction-bundle.post.response(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.; (xsd)status:string>
< The location header created by processing this operation, populated if the operation returns a location.; (xsd)location:uri>?
< The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)). Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.; (xsd)etag:string>?
< The date/time that the resource was modified on the server. This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.; (xsd)lastModified:instant>?
< An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction. For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.
This outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.; (xsd)outcome:Resource>?🔗 Information about the search process that lead to the creation of this entry.transaction-bundle.post.search(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence. Binding: search-entry-mode (required, Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.); (xsd)mode:code>?
< When searching, the server's search ranking score for the entry. Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.
See [Patient Match](patient-operation-match.html) for the EMPI search which relates to this element.; (xsd)score:decimal>?🔗 An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).transaction-bundle.put(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< A series of links that provide context to this entry.; (xsd)link:Bundle.link>*
< The Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when:
* invoking a create
* invoking or responding to an operation where the body is not a single identified resource
* invoking or returning the results of a search or history operation. fullUrl might not be [unique in the context of a resource](bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](references.html), the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the [regex](references.html#regex), then the 'id' portion of the fullUrl SHALL end with the Resource.id.
Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).; (xsd)fullUrl:uri>
< The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. This is allowed to be a Parameters resource if and only if it is referenced by something else within the Bundle that provides context/meaning.; (xsd)resource:Resource>
< Information about the search process that lead to the creation of this entry.; (xsd)search:transaction-bundle.put.search>{0,0}
< Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.; (xsd)request:transaction-bundle.put.request>
< Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.; (xsd)response:transaction-bundle.put.response>{0,0}🔗 Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.transaction-bundle.put.request(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred. Binding: http-verb (required, HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details.); (xsd)method:code>
< The URL for this entry, relative to the root (the address to which the request is posted). E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]".; (xsd)url:uri>
< If the ETag values match, return a 304 Not Modified status. See the API documentation for ["Conditional Read"](http.html#cread).; (xsd)ifNoneMatch:string>?
< Only perform the operation if the last updated date matches. See the API documentation for ["Conditional Read"](http.html#cread).; (xsd)ifModifiedSince:instant>?
< Only perform the operation if the Etag value matches. For more information, see the API section ["Managing Resource Contention"](http.html#concurrency).; (xsd)ifMatch:string>?
< Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for ["Conditional Create"](http.html#ccreate). This is just the query portion of the URL - what follows the "?" (not including the "?").; (xsd)ifNoneExist:string>?🔗 Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.transaction-bundle.put.response(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.; (xsd)status:string>
< The location header created by processing this operation, populated if the operation returns a location.; (xsd)location:uri>?
< The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)). Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.; (xsd)etag:string>?
< The date/time that the resource was modified on the server. This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.; (xsd)lastModified:instant>?
< An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction. For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.
This outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.; (xsd)outcome:Resource>?🔗 Information about the search process that lead to the creation of this entry.transaction-bundle.put.search(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence. Binding: search-entry-mode (required, Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.); (xsd)mode:code>?
< When searching, the server's search ranking score for the entry. Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.
See [Patient Match](patient-operation-match.html) for the EMPI search which relates to this element.; (xsd)score:decimal>?🔗 A container for a collection of resources.transaction-response-bundle(xsd)(doc)=
<#base:Bundle>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< A persistent identifier for the bundle that won't change as a bundle is copied from server to server. Persistent identity generally only matters for batches of type Document, Message, and Collection. It would not normally be populated for search and history results and servers ignore Bundle.identifier when processing batches and transactions. For Documents the .identifier SHALL be populated such that the .identifier is globally unique.; (xsd)identifier:Identifier>?
< Indicates the purpose of this bundle - how it is intended to be used. It's possible to use a bundle for other purposes (e.g. a document can be accepted as a transaction). This is primarily defined so that there can be specific rules for some of the bundle types. Binding: bundle-type (required, Indicates the purpose of a bundle - how it is intended to be used.); (xsd)type:code>
< The date/time that the bundle was assembled - i.e. when the resources were placed in the bundle. For many bundles, the timestamp is equal to .meta.lastUpdated, because they are not stored (e.g. search results). When a bundle is placed in a persistent store, .meta.lastUpdated will be usually be changed by the server. When the bundle is a message, a middleware agent altering the message (even if not stored) SHOULD update .meta.lastUpdated. .timestamp is used to track the original time of the Bundle, and SHOULD be populated.
Usage:
* document : the date the document was created. Note: the composition may predate the document, or be associated with multiple documents. The date of the composition - the authoring time - may be earlier than the document assembly time
* message : the date that the content of the message was assembled. This date is not changed by middleware engines unless they add additional data that changes the meaning of the time of the message
* history : the date that the history was assembled. This time would be used as the _since time to ask for subsequent updates
* searchset : the time that the search set was assembled. Note that different pages MAY have different timestamps but need not. Having different timestamps does not imply that subsequent pages will represent or include changes made since the initial query
* transaction | transaction-response | batch | batch-response | collection : no particular assigned meaning
The timestamp value should be greater than the lastUpdated and other timestamps in the resources in the bundle, and it should be equal or earlier than the .meta.lastUpdated on the Bundle itself.; (xsd)timestamp:instant>?
< If a set of search matches, this is the (potentially estimated) total number of entries of type 'match' across all pages in the search. It does not include search.mode = 'include' or 'outcome' entries and it does not provide a count of the number of entries in the Bundle. Only used if the bundle is a search result set. The total does not include resources such as OperationOutcome and included resources, only the total number of matching resources.; (xsd)total:unsignedInt>{0,0}
[]< A series of links that provide context to this bundle. Both Bundle.link and Bundle.entry.link are defined to support providing additional context when Bundles are used (e.g. [HATEOAS](http://en.wikipedia.org/wiki/HATEOAS)).
Bundle.entry.link corresponds to links found in the HTTP header if the resource in the entry was [read](http.html#read) directly.
This specification defines some specific uses of Bundle.link for [searching](search.html#conformance) and [paging](http.html#paging), but no specific uses for Bundle.entry.link, and no defined function in a transaction - the meaning is implementation specific. The behavior of navigation link types (next/prev/first/last) are well defined for searchset and history Bundles but are not currently defined for other types. Implementers who choose to use such link relationships for other bundle types will need to negotiate behavior with their interoperability partners.; (xsd)link:transaction-response-bundle.link>*
[]< An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).; (xsd)entry:transaction-response-bundle.entry>*
< Digital Signature - base64 encoded. XML-DSig or a JWS. The signature could be created by the "author" of the bundle or by the originating device. Requirements around inclusion of a signature, verification of signatures and treatment of signed/non-signed bundles is implementation-environment specific.; (xsd)signature:Signature>?
< Captures issues and warnings that relate to the construction of the Bundle and the content within it. Usage notes: These issues and warnings must apply to the Bundle as a whole, not to individual entries.Messages relating to the processing of individual entries (e.g. in a batch or transaction) SHALL be reported in the entry.response.outcome for that entry. If there are errors that arise in the creation of the Bundle, then that should be handled by an OperationOutcome being returned instead of the Bundle.; (xsd)issues:OperationOutcome>?🔗 An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).transaction-response-bundle.entry(xsd)(doc)=
<#base:Bundle.entry>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< A series of links that provide context to this entry.; (xsd)link:Bundle.link>*
< The Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when:
* invoking a create
* invoking or responding to an operation where the body is not a single identified resource
* invoking or returning the results of a search or history operation. fullUrl might not be [unique in the context of a resource](bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](references.html), the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the [regex](references.html#regex), then the 'id' portion of the fullUrl SHALL end with the Resource.id.
Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).; (xsd)fullUrl:uri>
< The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. This is allowed to be a Parameters resource if and only if it is referenced by something else within the Bundle that provides context/meaning.; (xsd)resource:Resource>?
< Information about the search process that lead to the creation of this entry.; (xsd)search:transaction-response-bundle.entry.search>{0,0}
< Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.; (xsd)request:transaction-response-bundle.entry.request>{0,0}
< Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.; (xsd)response:transaction-response-bundle.entry.response>?🔗 Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.transaction-response-bundle.entry.request(xsd)(doc)=
<#base:Bundle.entry.request>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred. Binding: http-verb (required, HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details.); (xsd)method:code>
< The URL for this entry, relative to the root (the address to which the request is posted). E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]".; (xsd)url:uri>
< If the ETag values match, return a 304 Not Modified status. See the API documentation for ["Conditional Read"](http.html#cread).; (xsd)ifNoneMatch:string>?
< Only perform the operation if the last updated date matches. See the API documentation for ["Conditional Read"](http.html#cread).; (xsd)ifModifiedSince:instant>?
< Only perform the operation if the Etag value matches. For more information, see the API section ["Managing Resource Contention"](http.html#concurrency).; (xsd)ifMatch:string>?
< Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for ["Conditional Create"](http.html#ccreate). This is just the query portion of the URL - what follows the "?" (not including the "?").; (xsd)ifNoneExist:string>?🔗 Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.transaction-response-bundle.entry.response(xsd)(doc)=
<#base:Bundle.entry.response>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.; (xsd)status:string>
< The location header created by processing this operation, populated if the operation returns a location.; (xsd)location:uri>?
< The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)). Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.; (xsd)etag:string>?
< The date/time that the resource was modified on the server. This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.; (xsd)lastModified:instant>?
< An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction. For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.
This outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.; (xsd)outcome:Resource>?🔗 Information about the search process that lead to the creation of this entry.transaction-response-bundle.entry.search(xsd)(doc)=
<#base:Bundle.entry.search>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence. Binding: search-entry-mode (required, Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.); (xsd)mode:code>?
< When searching, the server's search ranking score for the entry. Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.
See [Patient Match](patient-operation-match.html) for the EMPI search which relates to this element.; (xsd)score:decimal>?🔗 A series of links that provide context to this bundle. Both Bundle.link and Bundle.entry.link are defined to support providing additional context when Bundles are used (e.g. [HATEOAS](http://en.wikipedia.org/wiki/HATEOAS)).
Bundle.entry.link corresponds to links found in the HTTP header if the resource in the entry was [read](http.html#read) directly.
This specification defines some specific uses of Bundle.link for [searching](search.html#conformance) and [paging](http.html#paging), but no specific uses for Bundle.entry.link, and no defined function in a transaction - the meaning is implementation specific. The behavior of navigation link types (next/prev/first/last) are well defined for searchset and history Bundles but are not currently defined for other types. Implementers who choose to use such link relationships for other bundle types will need to negotiate behavior with their interoperability partners.transaction-response-bundle.link(xsd)(doc)=
<#base:Bundle.link>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A name which details the functional use for this link - see [http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1](http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1). Binding: iana-link-relations (required, ); (xsd)relation:code>
< The reference details for the link.; (xsd)url:uri>🔗 Record of transport of item.Transport(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< Identifier for the transport event that is used to identify it across multiple disparate systems. This identifier is typically assigned by the dispenser, and may be used to reference the delivery when exchanging information about it with other systems.; (xsd)identifier:Identifier>*
< The URL pointing to a *FHIR*-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Transport.; (xsd)instantiatesCanonical:ActivityDefinition*>?
< The URL pointing to an *externally* maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Transport.; (xsd)instantiatesUri:uri>?
[]< BasedOn refers to a higher-level authorization that triggered the creation of the transport. It references a "request" resource such as a ServiceRequest or Transport, which is distinct from the "request" resource the Transport is seeking to fulfill. This latter resource is referenced by FocusOn. For example, based on a ServiceRequest (= BasedOn), a transport is created to fulfill a procedureRequest ( = FocusOn ) to transport a specimen to the lab.; (xsd)basedOn:Resource*>*
< A shared identifier common to multiple independent Request instances that were activated/authorized more or less simultaneously by a single author. The presence of the same identifier on each request ties those requests together and may have business ramifications in terms of reporting of results, billing, etc. E.g. a requisition number shared by a set of lab tests ordered together, or a prescription number shared by all meds ordered at one time.; (xsd)groupIdentifier:Identifier>?
[]< A larger event of which this particular event is a component or step. Not to be used to link an event to an Encounter - use Event.context for that.
[The allowed reference resources may be adjusted as appropriate for the event resource].; (xsd)partOf:Transport*>*
< A code specifying the state of the transport event. Binding: transport-status (required, Status of the transport.); (xsd)status:code>?
< An explanation as to why this transport is held, failed, was refused, etc. This applies to the current status. Look at the history of the transport to see reasons for past statuses. Binding: transport-status-reason (example, Codes to identify the reason for current status. These will typically be specific to a particular workflow.); (xsd)statusReason:CodeableConcept>?
< Indicates the "level" of actionability associated with the Transport, i.e. i+R[9]Cs this a proposed transport, a planned transport, an actionable transport, etc. This element is immutable. Proposed transports, planned transports, etc. must be distinct instances.
In most cases, Transports will have an intent of "order". Binding: transport-intent (required, Distinguishes whether the transport is a proposal, plan or full order.); (xsd)intent:code>
< Indicates how quickly the Transport should be addressed with respect to other requests. Binding: request-priority (required, The priority of a transport (may affect service level applied to the transport).); (xsd)priority:code>?
< A name or code (or both) briefly describing what the transport involves. The title (eg "My Transports", "Outstanding Transports for Patient X") should go into the code. Binding: transport-code (example, Codes to identify what the transport involves. These will typically be specific to a particular workflow.); (xsd)code:CodeableConcept>?
< A free-text description of what is to be performed.; (xsd)description:string>?
< The request being actioned or the resource being manipulated by this transport. If multiple resources need to be manipulated, use sub-transports. (This ensures that status can be tracked independently for each referenced resource.).; (xsd)focus:Resource*>?
< The entity who benefits from the performance of the service specified in the transport (e.g., the patient).; (xsd)for:Resource*>?
< The healthcare event (e.g. a patient and healthcare provider interaction) during which this transport was created.; (xsd)encounter:Encounter*>?
< Identifies the completion time of the event (the occurrence).; (xsd)completionTime:dateTime>?
< The date and time this transport was created.; (xsd)authoredOn:dateTime>?
< The date and time of last modification to this transport.; (xsd)lastModified:dateTime>?
< The creator of the transport.; (xsd)requester:(<Device>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>?
[]< The kind of participant that should perform the transport. Binding: performer-role (preferred, The type(s) of transport performers allowed.); (xsd)performerType:CodeableConcept>*
< Individual organization or Device currently responsible for transport execution. Transports may be created with an owner not yet identified.; (xsd)owner:(<CareTeam>
|<Device>
|<HealthcareService>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>?
< Principal physical location where this transport is performed.; (xsd)location:Location*>?
[]< Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be relevant to the Transport.; (xsd)insurance:(<ClaimResponse>
|<Coverage>)>*
[]< Free-text information captured about the transport as it progresses.; (xsd)note:Annotation>*
[]< Links to Provenance records for past versions of this Transport that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the transport. This element does not point to the Provenance associated with the *current* version of the resource - as it would be created after this version existed. The Provenance for the current version can be retrieved with a _revinclude.; (xsd)relevantHistory:Provenance*>*
< If the Transport.focus is a request resource and the transport is seeking fulfillment (i.e. is asking for the request to be actioned), this element identifies any limitations on what parts of the referenced request should be actioned.; (xsd)restriction:Transport.restriction>?
[]< Additional information that may be needed in the execution of the transport.; (xsd)input:Transport.input>*
[]< Outputs produced by the Transport.; (xsd)output:Transport.output>*
< The desired or final location for the transport.; (xsd)requestedLocation:Location*>
< The current location for the entity to be transported.; (xsd)currentLocation:Location*>
< A resource reference indicating why this transport needs to be performed. Transports might be justified based on an Observation, a Condition, a past or planned procedure, etc. This should only be included if there is no focus or if it differs from the reason indicated on the focus. Use the CodeableConcept text element in `Transport.reasonCode` if the data is free (uncoded) text. Binding: (example, Indicates why the transport is needed. E.g. Suspended because patient admitted to hospital.); (xsd)reason:Resource*>?
< The transport event prior to this one.; (xsd)history:Transport*>?🔗 Additional information that may be needed in the execution of the transport.Transport.input(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A code or description indicating how the input is intended to be used as part of the transport execution. If referencing a BPMN workflow or Protocol, the "system" is the URL for the workflow definition and the code is the "name" of the required input. Binding: (example, Codes to identify types of input parameters. These will typically be specific to a particular workflow. E.g. "Comparison source", "Applicable consent", "Concomitent Medications", etc.); (xsd)type:CodeableConcept>
(<valueAddress:Address>
|<valueAge:Age>
|<valueAnnotation:Annotation>
|<valueAttachment:Attachment>
|<valueAvailability:Availability>
|<valueBase64Binary:base64Binary>
|<valueBoolean:boolean>
|<valueCode:code>
|<valueCodeableConcept:CodeableConcept>
|<valueCoding:Coding>
|<valueContactDetail:ContactDetail>
|<valueContactPoint:ContactPoint>
|<valueCount:Count>
|<valueDataRequirement:DataRequirement>
|<valueDate:date>
|<valueDateTime:dateTime>
|<valueDecimal:decimal>
|<valueDistance:Distance>
|<valueDosage:Dosage>
|<valueDuration:Duration>
|<valueExpression:Expression>
|<valueExtendedContactDetail:ExtendedContactDetail>
|<valueHumanName:HumanName>
|<valueId:id>
|<valueIdentifier:Identifier>
|<valueInstant:instant>
|<valueInteger:integer>
|<valueInteger64:integer64>
|<valueMarkdown:markdown>
|<valueMeta:Meta>
|<valueMoney:Money>
|<valueOid:oid>
|<valueParameterDefinition:ParameterDefinition>
|<valuePeriod:Period>
|<valuePositiveInt:positiveInt>
|<valueQuantity:Quantity>
|<valueRange:Range>
|<valueRatio:Ratio>
|<valueRatioRange:RatioRange>
|<valueRelatedArtifact:RelatedArtifact>
|<valueResource:Resource>
|<valueSampledData:SampledData>
|<valueSignature:Signature>
|<valueString:string>
|<valueTime:time>
|<valueTiming:Timing>
|<valueTriggerDefinition:TriggerDefinition>
|<valueUnsignedInt:unsignedInt>
|<valueUri:uri>
|<valueUrl:url>
|<valueUsageContext:UsageContext>
|<valueUuid:uuid>)🔗 Outputs produced by the Transport.Transport.output(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The name of the Output parameter. Binding: (example, Codes to identify types of input parameters. These will typically be specific to a particular workflow. E.g. "Identified issues", "Preliminary results", "Filler order", "Final results", etc.); (xsd)type:CodeableConcept>
(<valueAddress:Address>
|<valueAge:Age>
|<valueAnnotation:Annotation>
|<valueAttachment:Attachment>
|<valueAvailability:Availability>
|<valueBase64Binary:base64Binary>
|<valueBoolean:boolean>
|<valueCode:code>
|<valueCodeableConcept:CodeableConcept>
|<valueCoding:Coding>
|<valueContactDetail:ContactDetail>
|<valueContactPoint:ContactPoint>
|<valueCount:Count>
|<valueDataRequirement:DataRequirement>
|<valueDate:date>
|<valueDateTime:dateTime>
|<valueDecimal:decimal>
|<valueDistance:Distance>
|<valueDosage:Dosage>
|<valueDuration:Duration>
|<valueExpression:Expression>
|<valueExtendedContactDetail:ExtendedContactDetail>
|<valueHumanName:HumanName>
|<valueId:id>
|<valueIdentifier:Identifier>
|<valueInstant:instant>
|<valueInteger:integer>
|<valueInteger64:integer64>
|<valueMarkdown:markdown>
|<valueMeta:Meta>
|<valueMoney:Money>
|<valueOid:oid>
|<valueParameterDefinition:ParameterDefinition>
|<valuePeriod:Period>
|<valuePositiveInt:positiveInt>
|<valueQuantity:Quantity>
|<valueRange:Range>
|<valueRatio:Ratio>
|<valueRatioRange:RatioRange>
|<valueRelatedArtifact:RelatedArtifact>
|<valueResource:Resource>
|<valueSampledData:SampledData>
|<valueSignature:Signature>
|<valueString:string>
|<valueTime:time>
|<valueTiming:Timing>
|<valueTriggerDefinition:TriggerDefinition>
|<valueUnsignedInt:unsignedInt>
|<valueUri:uri>
|<valueUrl:url>
|<valueUsageContext:UsageContext>
|<valueUuid:uuid>)🔗 If the Transport.focus is a request resource and the transport is seeking fulfillment (i.e. is asking for the request to be actioned), this element identifies any limitations on what parts of the referenced request should be actioned.Transport.restriction(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Indicates the number of times the requested action should occur.; (xsd)repetitions:positiveInt>?
< Over what time-period is fulfillment sought. Note that period.high is the due date representing the time by which the transport should be completed.; (xsd)period:Period>?
[]< For requests that are targeted to more than one potential recipient/target, to identify who is fulfillment is sought for.; (xsd)recipient:(<Group>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>*🔗 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(xsd)(doc)=
<#base:DataType>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< The type of triggering event. Binding: trigger-type (required, The type of trigger.); (xsd)type:code>
< 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.; (xsd)name:string>?
< A code that identifies the event.; (xsd)code:CodeableConcept>?
< A reference to a SubscriptionTopic resource that defines the event. If this element is provided, no other information about the trigger definition may be supplied.; (xsd)subscriptionTopic:SubscriptionTopic*>?
< The timing of the event (if this is a periodic trigger).; (xsd)timing:(<date>
|<dateTime>
|<Schedule>
|<Timing>)>?
[]< 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.; (xsd)data:DataRequirement>*
< 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.; (xsd)condition:Expression>?🔗 Group of elements for Triglyceride result. Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as laboratory reports, etc.triglyceride(xsd)(doc)=
<#base:Observation>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< A unique identifier assigned to this observation.; (xsd)identifier:Identifier>*
< The reference to a FHIR ObservationDefinition resource that provides the definition that is adhered to in whole or in part by this Observation instance. ObservationDefinition can be referenced by its canonical url using instantiatesCanonical, or by a name or an identifier using the appropriate sub-elements of instantiatesReference.; (xsd)instantiates:ObservationDefinition*>?
[]< A plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed.; (xsd)basedOn:(<CarePlan>
|<DeviceRequest>
|<ImmunizationRecommendation>
|<MedicationRequest>
|<NutritionOrder>
|<ServiceRequest>)>*
[]< Identifies the observation(s) that triggered the performance of this observation.; (xsd)triggeredBy:triglyceride.triggeredBy>*
[]< A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure. To link an Observation to an Encounter use `encounter`. See the [Notes](observation.html#obsgrouping) below for guidance on referencing another Observation.; (xsd)partOf:(<GenomicStudy>
|<ImagingStudy>
|<Immunization>
|<MedicationAdministration>
|<MedicationDispense>
|<MedicationStatement>
|<Procedure>)>*
< The status of the result value. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. Binding: observation-status (required, Codes providing the status of an observation.); (xsd)status:code>
[]< A code that classifies the general type of observation being made. In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set. Binding: observation-category (preferred, Codes for high level observation categories.); (xsd)category:CodeableConcept>*
< Triglyceride. *All* code-value and, if present, component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. Binding: observation-codes (example, Codes identifying names of simple observations.); (xsd)code:CodeableConcept>
< The patient, or group of patients, location, device, organization, procedure or practitioner this observation is about and into whose or what record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the `focus` element or the `code` itself specifies the actual focus of the observation. One would expect this element to be a cardinality of 1..1. The only circumstance in which the subject can be missing is when the observation is made by a device that does not know the patient. In this case, the observation SHALL be matched to a patient through some context/channel matching technique, and at this point, the observation should be updated. The subject of an Observation may in some cases be a procedure. This supports the regulatory inspection use case where observations are captured during inspections of a procedure that is being performed (independent of any particular patient or whether patient related at all).; (xsd)subject:(<BiologicallyDerivedProduct>
|<Device>
|<Group>
|<Location>
|<Medication>
|<NutritionProduct>
|<Organization>
|<Patient>
|<Practitioner>
|<Procedure>
|<Substance>)>?
[]< The actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also be an existing condition, an intervention, the subject's diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child's tracheostomy tube. In this example, the child is the patient of record and the mother is the focus. Typically, an observation is made about the subject - a patient, or group of patients, location, or device - and the distinction between the subject and what is directly measured for an observation is specified in the observation code itself ( e.g., "Blood Glucose") and does not need to be represented separately using this element. Use `specimen` if a reference to a specimen is required. If a code is required instead of a resource use either `bodysite` for bodysites or the standard extension [http://hl7.org/fhir/StructureDefinition/observation-focusCode](http://hl7.org/fhir/extensions/StructureDefinition-observation-focusCode.html).; (xsd)focus:Resource*>*
< The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made. This will typically be the encounter the event occurred within, but some events may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission laboratory tests).; (xsd)encounter:Encounter*>?
< The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the "physiologically relevant time". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself. At least a date should be present unless this observation is a historical report. For recording imprecise or "fuzzy" times (For example, a blood glucose measurement taken "after breakfast") use the [Timing](datatypes.html#timing) datatype which allow the measurement to be tied to regular life events.; (xsd)effective:(<dateTime>
|<instant>
|<Period>
|<Timing>)>?
< The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified. For Observations that don't require review and verification, it may be the same as the [`lastUpdated` ](resource-definitions.html#Meta.lastUpdated) time of the resource itself. For Observations that do require review and verification for certain updates, it might not be the same as the `lastUpdated` time of the resource itself due to a non-clinically significant update that doesn't require the new version to be reviewed and verified again.; (xsd)issued:instant>?
[]< Who was responsible for asserting the observed value as "true".; (xsd)performer:(<CareTeam>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>*
(<valueAttachment:Attachment>
|<valueBoolean:boolean>
|<valueCodeableConcept:CodeableConcept>
|<valueDateTime:dateTime>
|<valueInteger:integer>
|<valueMolecularSequence:MolecularSequence>
|<valuePeriod:Period>
|<valueQuantity:Quantity>
|<valueRange:Range>
|<valueRatio:Ratio>
|<valueSampledData:SampledData>
|<valueString:string>
|<valueTime:time>)?
< Provides a reason why the expected value in the element Observation.value[x] is missing. Null or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be "detected", "not detected", "inconclusive", or "specimen unsatisfactory".
The alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code "error" could be used when the measurement was not completed. Note that an observation may only be reported if there are values to report. For example differential cell counts values may be reported only when > 0. Because of these options, use-case agreements are required to interpret general observations for null or exceptional values. Binding: data-absent-reason (extensible, Codes specifying why the result (`Observation.value[x]`) is missing.); (xsd)dataAbsentReason:CodeableConcept>?
< + | ++ | +++ | - | -- | ---. Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Binding: observation-interpretation (extensible, Codes identifying interpretations of observations.); (xsd)interpretation:CodeableConcept>?
[]< Comments about result. May include general statements about the observation, or statements about significant, unexpected or unreliable results values, or information about its source when relevant to its interpretation.; (xsd)note:Annotation>*
< Indicates the site on the subject's body where the observation was made (i.e. the target site). Only used if not implicit in code found in Observation.code. In many systems, this may be represented as a related observation instead of an inline component. Binding: body-site (example, SNOMED CT Body site concepts); (xsd)bodySite:CodeableConcept>?
< Indicates the body structure on the subject's body where the observation was made (i.e. the target site). Only used if not implicit in code found in Observation.code or bodySite is used. In many systems, this may be represented as a related observation instead of an inline component.; (xsd)bodyStructure:BodyStructure*>?
< Indicates the mechanism used to perform the observation. Only used if not implicit in code for Observation.code. Binding: observation-methods (example, Methods for simple observations.); (xsd)method:CodeableConcept>?
< The specimen that was used when this observation was made. Should only be used if not implicit in code found in `Observation.code`. Observations are not made on specimens themselves; they are made on a subject, but in many cases by the means of a specimen. Note that although specimens are often involved, they are not always tracked and reported explicitly. Also note that observation resources may be used in contexts that track the specimen explicitly (e.g. Diagnostic Report).; (xsd)specimen:(<Group>
|<Specimen>)>?
< A reference to the device that generates the measurements or the device settings for the device. Note that this is not meant to represent a device involved in the transmission of the result, e.g., a gateway. Such devices may be documented using the Provenance resource where relevant.; (xsd)device:(<Device>
|<DeviceMetric>)>?
< Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an "OR". In other words, to represent two distinct target populations, two `referenceRange` elements would be used. Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.; (xsd)referenceRange:triglyceride.referenceRange>
< This observation is a group observation (e.g. a battery, a panel of tests, a set of vital sign measurements) that includes the target as a member of the group. When using this element, an observation will typically have either a value or a set of related resources, although both may be present in some cases. For a discussion on the ways Observations can assembled in groups together, see [Notes](observation.html#obsgrouping) below. Note that a system may calculate results from [QuestionnaireResponse](questionnaireresponse.html) into a final score and represent the score as an Observation.; (xsd)hasMember:(<MolecularSequence>
|<Observation>
|<QuestionnaireResponse>)>{0,0}
< The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image. All the reference choices that are listed in this element can represent clinical observations and other measurements that may be the source for a derived value. The most common reference will be another Observation. For a discussion on the ways Observations can assembled in groups together, see [Notes](observation.html#obsgrouping) below.; (xsd)derivedFrom:(<DocumentReference>
|<GenomicStudy>
|<ImagingSelection>
|<ImagingStudy>
|<MolecularSequence>
|<Observation>
|<QuestionnaireResponse>)>{0,0}
[]< Some observations have multiple component observations. These component observations are expressed as separate code value pairs that share the same attributes. Examples include systolic and diastolic component observations for blood pressure measurement and multiple component observations for genetics observations. For a discussion on the ways Observations can be assembled in groups together see [Notes](observation.html#notes) below.; (xsd)component:triglyceride.component>*
< Triglyceride value. If a result is not available, use the comments field. - An observation may have:
1. a single value here
1. both a value and a set of related or component values
1. only a set of related or component values.
- If a value is present, the datatype for this element should be determined by the `code`.
- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.
- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.
- The usage of valueReference is restricted to the MolecularSequence resource when used as a definitional resource, not as a patient-specific finding. .
- For additional guidance, see the [Notes section](observation.html#notes) below.; (xsd)valueQuantity:Quantity>?🔗 Some observations have multiple component observations. These component observations are expressed as separate code value pairs that share the same attributes. Examples include systolic and diastolic component observations for blood pressure measurement and multiple component observations for genetics observations. For a discussion on the ways Observations can be assembled in groups together see [Notes](observation.html#notes) below.triglyceride.component(xsd)(doc)=
<#base:Observation.component>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Describes what was observed. Sometimes this is called the observation "code". *All* code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. Binding: observation-codes (example, Codes identifying names of simple observations.); (xsd)code:CodeableConcept>
(<valueAttachment:Attachment>
|<valueBoolean:boolean>
|<valueCodeableConcept:CodeableConcept>
|<valueDateTime:dateTime>
|<valueInteger:integer>
|<valueMolecularSequence:MolecularSequence>
|<valuePeriod:Period>
|<valueQuantity:Quantity>
|<valueRange:Range>
|<valueRatio:Ratio>
|<valueSampledData:SampledData>
|<valueString:string>
|<valueTime:time>)?
< Provides a reason why the expected value in the element Observation.component.value[x] is missing. "Null" or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be "detected", "not detected", "inconclusive", or "test not done".
The alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code "error" could be used when the measurement was not completed. Because of these options, use-case agreements are required to interpret general observations for exceptional values. Binding: data-absent-reason (extensible, Codes specifying why the result (`Observation.value[x]`) is missing.); (xsd)dataAbsentReason:CodeableConcept>?
[]< A categorical assessment of an observation value. For example, high, low, normal. Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Binding: observation-interpretation (extensible, Codes identifying interpretations of observations.); (xsd)interpretation:CodeableConcept>*
[]< Guidance on how to interpret the value by comparison to a normal or recommended range. Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.; (xsd)referenceRange:Observation.referenceRange>*🔗 Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an "OR". In other words, to represent two distinct target populations, two `referenceRange` elements would be used. Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.triglyceride.referenceRange(xsd)(doc)=
<#base:Observation.referenceRange>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The value of the low bound of the reference range. The low bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the low bound is omitted, it is assumed to be meaningless (e.g. reference range is <=2.3).; (xsd)low:SimpleQuantity>{0,0}
< The value of the high bound of the reference range. The high bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the high bound is omitted, it is assumed to be meaningless (e.g. reference range is >= 2.3). Per Australian NHF Recommendations.; (xsd)high:SimpleQuantity>
< The value of the normal value of the reference range. Binding: observation-referencerange-normalvalue (extensible, Codes identifying the normal value of the observation.); (xsd)normalValue:CodeableConcept>?
< Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range. This SHOULD be populated if there is more than one range. If this element is not present then the normal range is assumed. Binding: referencerange-meaning (preferred, Code for the meaning of a reference range.); (xsd)type:CodeableConcept>{0,0}
< Codes to indicate the target population this reference range applies to. For example, a reference range may be based on the normal population or a particular sex or race. Multiple `appliesTo` are interpreted as an "AND" of the target populations. For example, to represent a target population of African American females, both a code of female and a code for African American would be used. This SHOULD be populated if there is more than one range. If this element is not present then the normal population is assumed. Binding: referencerange-appliesto (example, Codes identifying the population the reference range applies to.); (xsd)appliesTo:CodeableConcept>{0,0}
< The age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so.; (xsd)age:Range>{0,0}
< Text based reference range in an observation which may be used when a quantitative range is not appropriate for an observation. An example would be a reference value of "Negative" or a list or table of "normals".; (xsd)text:markdown>?🔗 Identifies the observation(s) that triggered the performance of this observation.triglyceride.triggeredBy(xsd)(doc)=
<#base:Observation.triggeredBy>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Reference to the triggering observation.; (xsd)observation:Observation*>
< The type of trigger.
Reflex | Repeat | Re-run. Binding: observation-triggeredbytype (required, The type of TriggeredBy Observation.); (xsd)type:code>
< Provides the reason why this observation was performed as a result of the observation(s) referenced.; (xsd)reason:string>?🔗 A single issue - either an indication, contraindication, interaction or an undesirable effect for a medicinal product, medication, device or procedure.UndesirableEffectDefinition(xsd)(doc)=
<#base:ClinicalUseDefinition>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< Business identifier for this issue.; (xsd)identifier:Identifier>*
< indication | contraindication | interaction | undesirable-effect | warning. Binding: clinical-use-definition-type (required, Overall defining type of this clinical use definition.) undesirable-effect; (xsd)type:code>
[]< A categorisation of the issue, primarily for dividing warnings into subject heading areas such as "Pregnancy and Lactation", "Overdose", "Effects on Ability to Drive and Use Machines". Binding: clinical-use-definition-category (preferred, A categorisation for a clinical use information item.); (xsd)category:CodeableConcept>*
[]< The medication, product, substance, device, procedure etc. for which this is an indication.; (xsd)subject:(<ActivityDefinition>
|<BiologicallyDerivedProduct>
|<Device>
|<DeviceDefinition>
|<Medication>
|<MedicinalProductDefinition>
|<NutritionProduct>
|<PlanDefinition>
|<Substance>)>*
< Whether this is a current issue or one that has been retired etc. Binding: publication-status (preferred, The lifecycle status of an artifact.); (xsd)status:CodeableConcept>?
< Specifics for when this is a contraindication.; (xsd)contraindication:UndesirableEffectDefinition.contraindication>{0,0}
< Specifics for when this is an indication.; (xsd)indication:UndesirableEffectDefinition.indication>{0,0}
< Specifics for when this is an interaction.; (xsd)interaction:UndesirableEffectDefinition.interaction>{0,0}
[]< The population group to which this applies.; (xsd)population:Group*>*
[]< Logic used by the clinical use definition.; (xsd)library:Library*>*
< Describe the possible undesirable effects (negative outcomes) from the use of the medicinal product as treatment.; (xsd)undesirableEffect:UndesirableEffectDefinition.undesirableEffect>
< A critical piece of information about environmental, health or physical risks or hazards that serve as caution to the user. For example 'Do not operate heavy machinery', 'May cause drowsiness', or 'Get medical advice/attention if you feel unwell'.; (xsd)warning:UndesirableEffectDefinition.warning>{0,0}🔗 Specifics for when this is a contraindication.UndesirableEffectDefinition.contraindication(xsd)(doc)=
<#base:ClinicalUseDefinition.contraindication>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The situation that is being documented as contraindicating against this item. Binding: disease-symptom-procedure (example, A symptom, disease or procedure.); (xsd)diseaseSymptomProcedure:ObservationDefinition*>?
< The status of the disease or symptom for the contraindication, for example "chronic" or "metastatic". Binding: disease-status (example, The status of a disease or symptom.); (xsd)diseaseStatus:ObservationDefinition*>?
[]< A comorbidity (concurrent condition) or coinfection. Binding: disease-symptom-procedure (example, A symptom, disease or procedure.); (xsd)comorbidity:ObservationDefinition*>*
[]< The indication which this is a contraidication for.; (xsd)indication:ClinicalUseDefinition*>*
< An expression that returns true or false, indicating whether the indication is applicable or not, after having applied its other elements. The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.; (xsd)applicability:Expression>?
[]< Information about the use of the medicinal product in relation to other therapies described as part of the contraindication.; (xsd)otherTherapy:UndesirableEffectDefinition.contraindication.otherTherapy>*🔗 Information about the use of the medicinal product in relation to other therapies described as part of the contraindication.UndesirableEffectDefinition.contraindication.otherTherapy(xsd)(doc)=
<#base:ClinicalUseDefinition.contraindication.otherTherapy>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The type of relationship between the medicinal product indication or contraindication and another therapy. Binding: therapy-relationship-type (preferred, Classification of relationship between a therapy and a contraindication or an indication.); (xsd)relationshipType:CodeableConcept>
< Reference to a specific medication (active substance, medicinal product or class of products, biological, food etc.) as part of an indication or contraindication. Binding: therapy (example, A therapy.); (xsd)treatment:(<ActivityDefinition>
|<BiologicallyDerivedProduct>
|<Medication>
|<MedicinalProductDefinition>
|<NutritionProduct>
|<Substance>
|<SubstanceDefinition>)>🔗 Specifics for when this is an indication.UndesirableEffectDefinition.indication(xsd)(doc)=
<#base:ClinicalUseDefinition.indication>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The situation that is being documented as an indicaton for this item. Binding: disease-symptom-procedure (example, A symptom, disease or procedure.); (xsd)diseaseSymptomProcedure:ObservationDefinition*>?
< The status of the disease or symptom for the indication, for example "chronic" or "metastatic". Binding: disease-status (example, The status of a disease or symptom.); (xsd)diseaseStatus:ObservationDefinition*>?
[]< A comorbidity (concurrent condition) or coinfection as part of the indication. Binding: disease-symptom-procedure (example, A symptom, disease or procedure.); (xsd)comorbidity:ObservationDefinition*>*
< The intended effect, aim or strategy to be achieved. Binding: product-intended-use (preferred, The overall intended use of a product.); (xsd)intendedEffect:ObservationDefinition*>?
< Timing or duration information, that may be associated with use with the indicated condition e.g. Adult patients suffering from myocardial infarction (from a few days until less than 35 days), ischaemic stroke (from 7 days until less than 6 months).; (xsd)duration:(<Range>
|<string>)>?
[]< An unwanted side effect or negative outcome that may happen if you use the drug (or other subject of this resource) for this indication.; (xsd)undesirableEffect:ClinicalUseDefinition*>*
< An expression that returns true or false, indicating whether the indication is applicable or not, after having applied its other elements. The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.; (xsd)applicability:Expression>?
[]< Information about the use of the medicinal product in relation to other therapies described as part of the indication.; (xsd)otherTherapy:ClinicalUseDefinition.contraindication.otherTherapy>*🔗 Specifics for when this is an interaction.UndesirableEffectDefinition.interaction(xsd)(doc)=
<#base:ClinicalUseDefinition.interaction>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< The specific medication, product, food, substance etc. or laboratory test that interacts.; (xsd)interactant:UndesirableEffectDefinition.interaction.interactant>*
< The type of the interaction e.g. drug-drug interaction, drug-food interaction, drug-lab test interaction. Binding: interaction-type (example, A categorisation for an interaction between two substances.); (xsd)type:CodeableConcept>?
< The effect of the interaction, for example "reduced gastric absorption of primary medication". Binding: interaction-effect (example, A interaction effect of clinical use of a medication or other substance.); (xsd)effect:ObservationDefinition*>?
< The incidence of the interaction, e.g. theoretical, observed. Binding: interaction-incidence (example, A categorisation for incidence of occurence of an interaction.); (xsd)incidence:CodeableConcept>?
[]< Actions for managing the interaction. Binding: interaction-management (example, A type of management for an interaction of a medication or other substance.); (xsd)management:CodeableConcept>*🔗 The specific medication, product, food, substance etc. or laboratory test that interacts.UndesirableEffectDefinition.interaction.interactant(xsd)(doc)=
<#base:ClinicalUseDefinition.interaction.interactant>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The specific medication, product, food, substance etc. or laboratory test that interacts. Binding: interactant (example, An interactant - a substance that may have a clinically significant effect on another.); (xsd)item:(<BiologicallyDerivedProduct>
|<CodeableConcept>
|<Medication>
|<MedicinalProductDefinition>
|<NutritionProduct>
|<ObservationDefinition>
|<Substance>)>🔗 Describe the possible undesirable effects (negative outcomes) from the use of the medicinal product as treatment.UndesirableEffectDefinition.undesirableEffect(xsd)(doc)=
<#base:ClinicalUseDefinition.undesirableEffect>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The situation in which the undesirable effect may manifest. Binding: undesirable-effect-symptom (example, An undesirable effect of clinical use.); (xsd)symptomConditionEffect:ObservationDefinition*>?
< High level classification of the effect. Binding: undesirable-effect-classification (example, A categorisation for an undesirable effect.); (xsd)classification:CodeableConcept>?
< How often the effect is seen. Binding: undesirable-effect-frequency (example, A categorisation for a frequency of occurence of an undesirable effect.); (xsd)frequencyOfOccurrence:CodeableConcept>?🔗 A critical piece of information about environmental, health or physical risks or hazards that serve as caution to the user. For example 'Do not operate heavy machinery', 'May cause drowsiness', or 'Get medical advice/attention if you feel unwell'.UndesirableEffectDefinition.warning(xsd)(doc)=
<#base:ClinicalUseDefinition.warning>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A textual definition of this warning, with formatting.; (xsd)description:markdown>?
< A coded or unformatted textual definition of this warning. Binding: warning-type (example, Classification of warning type.); (xsd)code:CodeableConcept>?🔗 An integer with a value that is not negative (e.g. >= 0)unsignedInt(xsd)(doc)=
<#base:integer>
< unique id for the element within a resource (for internal references); (xsd)id:string>?
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< Primitive value for unsignedInt; (xsd)value:string>?🔗 String of characters used to identify a name or a resource see http://en.wikipedia.org/wiki/Uniform_resource_identifieruri(xsd)(doc)=
<#base:PrimitiveType>
< unique id for the element within a resource (for internal references); (xsd)id:string>?
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< The actual value; (xsd)value:string>?🔗 A URI that is a literal referenceurl(xsd)(doc)=
<#base:uri>
< unique id for the element within a resource (for internal references); (xsd)id:string>?
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< Primitive value for url; (xsd)value:string>?🔗 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(xsd)(doc)=
<#base:DataType>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< A code that identifies the type of context being specified by this usage context. Binding: http://terminology.hl7.org/ValueSet/usage-context-type (extensible, A code that specifies a type of context being specified by a usage context.); (xsd)code:Coding>
(<valueCodeableConcept:CodeableConcept>
|<valueGroup:Group>
|<valueHealthcareService:HealthcareService>
|<valueInsurancePlan:InsurancePlan>
|<valueLocation:Location>
|<valueOrganization:Organization>
|<valuePlanDefinition:PlanDefinition>
|<valueQuantity:Quantity>
|<valueRange:Range>
|<valueResearchStudy:ResearchStudy>)🔗 A UUID, represented as a URI See The Open Group, CDE 1.1 Remote Procedure Call specification, Appendix A.uuid(xsd)(doc)=
<#base:uri>
< unique id for the element within a resource (for internal references); (xsd)id:string>?
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< Primitive value for uuid; (xsd)value:string>?🔗 The period in which the Composition is valid (for Order Catalog profiles), with optional start and end dates.ValidityPeriod(xsd)(doc)=
<#base:Extension>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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. http://hl7.org/fhir/uv/order-catalog/StructureDefinition/ValidityPeriod; (xsd)url:string>
< Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R5/extensibility.html) for a list).; (xsd)value:Period>🔗 A ValueSet resource instance specifies a set of codes drawn from one or more code systems, intended for use in a particular context. Value sets link between [CodeSystem](codesystem.html) definitions and their use in [coded elements](terminologies.html).ValueSet(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
< An absolute URI that is used to identify this value set when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this value set is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the value set is stored on different servers. Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.
The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions).
In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.; (xsd)url:uri>?
[]< A formal identifier that is used to identify this value set when it is represented in other formats, or referenced in a specification, model, design or an instance. Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this value set outside of FHIR, where it is not possible to use the logical URI.; (xsd)identifier:Identifier>*
< The identifier that is used to identify this version of the value set when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the value set author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. There may be different value set instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the value set with the format [url]|[version]. The version SHOULD NOT contain a '#' - see [Business Version](resource.html#bv-format).; (xsd)version:string>?
< Indicates the mechanism used to compare versions to determine which ValueSet is more current. If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined. Binding: version-algorithm (extensible, ); (xsd)versionAlgorithm:(<Coding>
|<string>)>?
< A natural language name identifying the value set. This name should be usable as an identifier for the module by machine processing applications such as code generation. The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.A name should be provided unless the value set is a contained resource (e.g. an anonymous value set in a profile). Most registries will require a name.; (xsd)name:string>?
< A short, descriptive, user-friendly title for the value set. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.; (xsd)title:string>?
< The status of this value set. Enables tracking the life-cycle of the content. The status of the value set applies to the value set definition (ValueSet.compose) and the associated ValueSet metadata. Expansions do not have a state. Allows filtering of value sets that are appropriate for use versus not.See also the [http://hl7.org/fhir/StructureDefinition/valueset-workflowStatusDescription](http://hl7.org/fhir/extensions/StructureDefinition-valueset-workflowStatusDescription.html) extension for additional status information related to the editorial process.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization). Binding: publication-status (required, The lifecycle status of an artifact.); (xsd)status:code>
< A Boolean value to indicate that this value set is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. Allows filtering of value sets that are appropriate for use versus not.; (xsd)experimental:boolean>?
< The date (and optionally time) when the value set metadata or content logical definition (.compose) was created or revised. Note that this is not the same as the meta.lastUpdated which is specific to an instance of a value set resource on a server. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)date:dateTime>?
< The name of the organization or individual responsible for the release and ongoing maintenance of the value set. Usually an organization but may be an individual. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the value set. This item SHOULD be populated unless the information is available from context.; (xsd)publisher:string>?
[]< Contact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)contact:ContactDetail>*
< A free text natural language description of the value set from a consumer's perspective. The textual description specifies the span of meanings for concepts to be included within the Value Set Expansion, and also may specify the intended use and limitations of the Value Set. Description SHOULD contain instructions for clinical or administrative use and interpretation and information about misuse. Description SHOULD be populated unless the information is available from context. Description SHOULD be populated unless the value set is a contained resource (e.g. a value set defined solely in the context of a profile).; (xsd)description:markdown>?
[]< The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate value set instances. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.; (xsd)useContext:UsageContext>*
[]< A legal or geographic region in which the value set is intended to be used. It may be possible for the value set to be used in jurisdictions other than those for which it was originally designed or intended.
DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.) Binding: jurisdiction (extensible, Countries and regions within which this artifact is targeted for use.); (xsd)jurisdiction:CodeableConcept>*
< If this is set to 'true', then no new versions of the content logical definition can be created. Note: Other metadata might still change. Normally immutability is set to 'false', which is the default assumption if it is not populated. Note that the implication is that if this is set to 'true', there may be only one ValueSet version for this definition. Immutability tends to be set to 'true' in one of two cases: - Where the value set, by the nature of its usage, cannot change. For example "All specializations of ACT in ActClassCode" - Where there's no safe way to express the "Purpose" such that someone else could safely make changes to the value set definition. Source workflow control must guarantee that the same URI always yields the same definition.; (xsd)immutable:boolean>?
< Explanation of why this value set is needed and why it has been designed as it has. This element does not describe the usage of the value set. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this value set.; (xsd)purpose:markdown>?
< A copyright statement relating to the value set and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the value set. Frequently, the copyright differs between the value set and the codes that are included. The copyright statement should clearly differentiate between these when required.; (xsd)copyright:markdown>?
< A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved'). The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.; (xsd)copyrightLabel:string>?
< The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)approvalDate:date>?
< The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. If specified, this date follows the original approval date.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)lastReviewDate:date>?
< The period during which the ValueSet content was or is planned to be in active use. The effective period for a ValueSet determines when the content is applicable for usage and is independent of publication and review dates. For example, a valueset intended to be used for the year 2016 might be published in 2015.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)effectivePeriod:Period>?
[]< Descriptions related to the content of the ValueSet. Topics provide a high-level categorization as well as keywords for the ValueSet that can be useful for filtering and searching. DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'topic' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#topic and useContext.valueCodeableConcept indicating the topic) Binding: definition-topic (example, ); (xsd)topic:CodeableConcept>*
[]< An individiual or organization primarily involved in the creation and maintenance of the ValueSet.; (xsd)author:ContactDetail>*
[]< An individual or organization primarily responsible for internal coherence of the ValueSet.; (xsd)editor:ContactDetail>*
[]< An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the ValueSet. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)reviewer:ContactDetail>*
[]< An individual or organization asserted by the publisher to be responsible for officially endorsing the ValueSet for use in some setting. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).; (xsd)endorser:ContactDetail>*
[]< Related artifacts such as additional documentation, justification, dependencies, bibliographic references, and predecessor and successor artifacts. Each related artifact is either an attachment, or a reference to another resource, but not both.; (xsd)relatedArtifact:RelatedArtifact>*
< A set of criteria that define the contents of the value set by including or excluding codes selected from the specified code system(s) that the value set draws from. This is also known as the Content Logical Definition (CLD).; (xsd)compose:ValueSet.compose>?
< A value set can also be "expanded", where the value set is turned into a simple collection of enumerated codes. This element holds the expansion, if it has been performed. Expansion is performed to produce a collection of codes that are ready to use for data entry or validation. Value set expansions are always considered to be stateless - they are a record of the set of codes in the value set at a point in time under a given set of conditions, and are not subject to ongoing maintenance.
Expansion.parameter is a simplified list of parameters - a subset of the features of the [Parameters](parameters.html) resource.; (xsd)expansion:ValueSet.expansion>?
< Description of the semantic space the Value Set Expansion is intended to cover and should further clarify the text in ValueSet.description.; (xsd)scope:ValueSet.scope>?🔗 A set of criteria that define the contents of the value set by including or excluding codes selected from the specified code system(s) that the value set draws from. This is also known as the Content Logical Definition (CLD).ValueSet.compose(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The Locked Date is the effective date that is used to determine the version of all referenced Code Systems and Value Set Definitions included in the compose that are not already tied to a specific version. With a defined lockedDate the value set is considered "Locked". Otherwise, the value set may have different expansions as underlying code systems and/or value sets evolve. The interpretation of lockedDate is often dependent on the context - e.g. a SNOMED CT derived value set with a lockedDate will have a different expansion in USA than in UK. If a value set specifies a version for include and exclude statements, and also specifies a locked date, the specified versions need to be available that date, or the value set will not be usable.; (xsd)lockedDate:date>?
< Whether inactive codes - codes that are not approved for current use - are in the value set. If inactive = true, inactive codes are to be included in the expansion, if inactive = false, the inactive codes will not be included in the expansion. If absent, the behavior is determined by the implementation, or by the applicable $expand parameters (but generally, inactive codes would be expected to be included). Note that in the FHIR terminology framework, "deprecated" does not mean inactive, but in some code systems, e.g. LOINC, "deprecated" does mean inactive. Code systems should define what codes are considered to be inactive. If this is not clearly defined (including in the FHIR code system resource), then all codes are assumed to be active.
The Value Set Definition specification defines an ActiveOnly element, which is the reverse of this element e.g. (ValueSet.compose.inactive=FALSE) is the same as (VSD.ActiveOnly=TRUE).; (xsd)inactive:boolean>?
[]< Include one or more codes from a code system or other value set(s). All the conditions in an include must be true. If a system is listed, all the codes from the system are listed. If one or more filters are listed, all of the filters must apply. If one or more value sets are listed, the codes must be in all the value sets. E.g. each include is 'include all the codes that meet all these conditions'.; (xsd)include:ValueSet.compose.include>+
[]< Exclude one or more codes from the value set based on code system filters and/or other value sets. Usually this is used to selectively exclude codes that were included by subsumption in the inclusions. Any display names specified for the codes are ignored.; (xsd)exclude:ValueSet.compose.include>*
[]< A property to return in the expansion, if the client doesn't ask for any particular properties. May be either a code from the code system definition (convenient) or a the formal URI that refers to the property. The special value '*' means all properties known to the server. Note that property names can clash, so using a URI is recommended.; (xsd)property:string>*🔗 Include one or more codes from a code system or other value set(s). All the conditions in an include must be true. If a system is listed, all the codes from the system are listed. If one or more filters are listed, all of the filters must apply. If one or more value sets are listed, the codes must be in all the value sets. E.g. each include is 'include all the codes that meet all these conditions'.ValueSet.compose.include(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< An absolute URI which is the code system from which the selected codes come from. If there are no codes or filters, the entire code system is included. Note that the set of codes that are included may contain abstract codes. See ''Coding.system'' for further documentation about the correct value for the system element.; (xsd)system:uri>?
< The version of the code system that the codes are selected from, or the special version '*' for all versions. This is used when selecting the descendants of a concept - they may change between versions. If no version is specified, then the exact contents of the value set might not be known until a context of use binds it to a particular version. The special value '*' means all versions; It is at server discretion regarding expansions and which versions must be supported.; (xsd)version:string>?
[]< Specifies a concept to be included or excluded. The list of concepts is considered ordered, though the order might not have any particular significance. Typically, the order of an expansion follows that defined in the compose element.; (xsd)concept:ValueSet.compose.include.concept>*
[]< Select concepts by specifying a matching criterion based on the properties (including relationships) defined by the system, or on filters defined by the system. If multiple filters are specified within the include, they SHALL all be true. Selecting codes by specifying filters based on properties is only possible where the underlying code system defines appropriate properties. Note that in some cases, the underlying code system defines the logical concepts but not the literal codes for the concepts. In such cases, the literal definitions may be provided by a third party.; (xsd)filter:ValueSet.compose.include.filter>*
[]< Selects the concepts found in this value set (based on its value set definition). This is an absolute URI that is a reference to ValueSet.url. If multiple value sets are specified this includes the intersection of the contents of all of the referenced value sets. The value set URI is either a logical reference to a defined value set such as a [SNOMED CT reference set](https://terminology.hl7.org/SNOMEDCT.html), or a direct reference to a value set definition using ValueSet.url. The reference might not refer to an actual FHIR ValueSet resource; in this case, whatever is referred to is an implicit definition of a value set that needs to be clear about how versions are resolved.; (xsd)valueSet:ValueSet*>*
< A copyright statement for the specific code system asserted by the containing ValueSet.compose.include element's system value (if the associated ValueSet.compose.include.version element is not present); or the code system and version combination (if the associated ValueSet.compose.include.version element is present).; (xsd)copyright:string>?🔗 Specifies a concept to be included or excluded. The list of concepts is considered ordered, though the order might not have any particular significance. Typically, the order of an expansion follows that defined in the compose element.ValueSet.compose.include.concept(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Specifies a code for the concept to be included or excluded. Expressions are allowed if defined by the underlying code system.; (xsd)code>
< The text to display to the user for this concept in the context of this valueset. If no display is provided, then applications using the value set use the display specified for the code by the system. The value set resource allows for an alternative display to be specified for when this concept is used in this particular value set. See notes in the value set narrative about the correct use of this element.; (xsd)display:string>?
[]< Additional representations for this concept when used in this value set - other languages, aliases, specialized purposes, used for particular purposes, etc. Concepts have both a ```display``` and an array of ```designation```. The display is equivalent to a special designation with an implied ```designation.use``` of "primary code" and a language equal to the [Resource Language](resource.html#language).; (xsd)designation:ValueSet.compose.include.concept.designation>*🔗 Additional representations for this concept when used in this value set - other languages, aliases, specialized purposes, used for particular purposes, etc. Concepts have both a ```display``` and an array of ```designation```. The display is equivalent to a special designation with an implied ```designation.use``` of "primary code" and a language equal to the [Resource Language](resource.html#language).ValueSet.compose.include.concept.designation(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The language this designation is defined for. In the absence of a language, the resource language applies. Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< A code that represents types of uses of designations. If no use is provided, the designation can be assumed to be suitable for general display to a human user. Binding: designation-use (extensible, Details of how a designation would be used.); (xsd)use:Coding>?
[]< Additional codes that detail how this designation would be used, if there is more than one use. This was added rather than increasing the cardinality of .use to 0..* in order to maintain backward compatibility. Binding: designation-use (extensible, Details of how a designation would be used.); (xsd)additionalUse:Coding>*
< The text value for this designation.; (xsd)value:string>🔗 Select concepts by specifying a matching criterion based on the properties (including relationships) defined by the system, or on filters defined by the system. If multiple filters are specified within the include, they SHALL all be true. Selecting codes by specifying filters based on properties is only possible where the underlying code system defines appropriate properties. Note that in some cases, the underlying code system defines the logical concepts but not the literal codes for the concepts. In such cases, the literal definitions may be provided by a third party.ValueSet.compose.include.filter(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A code that identifies a property or a filter defined in the code system.; (xsd)property:code>
< The kind of operation to perform as a part of the filter criteria. In case filter.property represents a property of the system, the operation applies to the selected property. In case filter.property represents a filter of the system, the operation SHALL match one of the CodeSystem.filter.operator values. Binding: filter-operator (required, The kind of operation to perform as a part of a property based filter.); (xsd)op:code>
< The match value may be either a code defined by the system, or a string value, which is a regex match on the literal string of the property value (if the filter represents a property defined in CodeSystem) or of the system filter value (if the filter represents a filter defined in CodeSystem) when the operation is 'regex', or one of the values (true and false), when the operation is 'exists'. Use regex matching with care - full regex matching on every SNOMED CT term is prohibitive, for example.; (xsd)value:string>🔗 A value set can also be "expanded", where the value set is turned into a simple collection of enumerated codes. This element holds the expansion, if it has been performed. Expansion is performed to produce a collection of codes that are ready to use for data entry or validation. Value set expansions are always considered to be stateless - they are a record of the set of codes in the value set at a point in time under a given set of conditions, and are not subject to ongoing maintenance.
Expansion.parameter is a simplified list of parameters - a subset of the features of the [Parameters](parameters.html) resource.ValueSet.expansion(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< An identifier that uniquely identifies this expansion of the valueset, based on a unique combination of the provided parameters, the system default parameters, and the underlying system code system versions etc. Systems may re-use the same identifier as long as those factors remain the same, and the expansion is the same, but are not required to do so. This is a business identifier. Typically, this uri is a UUID (e.g. urn:uuid:8230ff20-c97a-4167-a59d-dc2cb9df16dd).; (xsd)identifier:uri>?
< As per paging Search results, the next URLs are opaque to the client, have no dictated structure, and only the server understands them. Clients SHOULD use the next link, if present, to page through expansion results in preference to using the offset and count parameters. Due to the optional nature of the next link, its absence does not necessarily indicate that it is the last page of results. Instead, as the offset and count parameters SHALL be populated when paging, clients can reliably use the count/offset parameters to determine whether the whole expansion is returned.; (xsd)next:uri>?
< The time at which the expansion was produced by the expanding system. This SHOULD be a fully populated instant, but in some circumstances, value sets are expanded by hand, and the expansion is published without that precision.; (xsd)timestamp:dateTime>
< The total number of concepts in the expansion. If the number of concept nodes in this resource is less than the stated number, then the server can return more using the offset parameter. Paging only applies to flat expansions.; (xsd)total:integer>?
< If paging is being used, the offset at which this resource starts. I.e. this resource is a partial view into the expansion. If paging is not being used, this element SHALL NOT be present. Paging only applies to flat expansions. If a filter is applied, the count is the number of concepts that matched the filter, not the number of concepts in an unfiltered view of the expansion.; (xsd)offset:integer>?
[]< A parameter that controlled the expansion process. These parameters may be used by users of expanded value sets to check whether the expansion is suitable for a particular purpose, or to pick the correct expansion. The server decides which parameters to include here, but at a minimum, the list SHOULD include all of the parameters that affect the $expand operation. If the expansion will be persisted all of these parameters SHALL be included. If the codeSystem on the server has a specified version then this version SHALL be provided as a parameter in the expansion (note that not all code systems have a version).; (xsd)parameter:ValueSet.expansion.parameter>*
[]< A property defines an additional slot through which additional information can be provided about a concept.; (xsd)property:ValueSet.expansion.property>*
[]< The codes that are contained in the value set expansion.; (xsd)contains:ValueSet.expansion.contains>*🔗 The codes that are contained in the value set expansion.ValueSet.expansion.contains(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< An absolute URI which is the code system in which the code for this item in the expansion is defined.; (xsd)system:uri>?
< If true, this entry is included in the expansion for navigational purposes, and the user cannot select the code directly as a proper value. This should not be understood to exclude its use for searching (e.g. by subsumption testing). The client should know whether it is appropriate for the user to select an abstract code or not.; (xsd)abstract:boolean>?
< If the concept is inactive in the code system that defines it. Inactive codes are those that are no longer to be used, but are maintained by the code system for understanding legacy data. It might not be known or specified whether a concept is inactive (and it may depend on the context of use). This should only have a value if the concept is inactive.; (xsd)inactive:boolean>?
< The version of the code system from this code was taken. 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. The exact value of the version string is specified by the system from which the code is derived.; (xsd)version:string>?
< The code for this item in the expansion hierarchy. If this code is missing the entry in the hierarchy is a place holder (abstract) and does not represent a valid code in the value set.; (xsd)code>?
< The recommended display for this item in the expansion.; (xsd)display:string>?
[]< Additional representations for this item - other languages, aliases, specialized purposes, used for particular purposes, etc. These are relevant when the conditions of the expansion do not fix to a single correct representation. The designations provided must be based on the value set and code system definitions.; (xsd)designation:ValueSet.compose.include.concept.designation>*
[]< A property value for this concept.; (xsd)property:ValueSet.expansion.contains.property>*
[]< Other codes and entries contained under this entry in the hierarchy. If the expansion uses this element, there is no implication about the logical relationship between them, and the structure cannot be used for logical inferencing. The structure exists to provide navigational assistance for helping human users to locate codes in the expansion.; (xsd)contains:ValueSet.expansion.contains>*🔗 A property value for this concept.ValueSet.expansion.contains.property(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A code that is a reference to ValueSet.expansion.property.code.; (xsd)code>
(<valueBoolean:boolean>
|<valueCode:code>
|<valueCoding:Coding>
|<valueDateTime:dateTime>
|<valueDecimal:decimal>
|<valueInteger:integer>
|<valueString:string>)
[]< A subproperty value for this concept.; (xsd)subProperty:ValueSet.expansion.contains.property.subProperty>*🔗 A subproperty value for this concept.ValueSet.expansion.contains.property.subProperty(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A code that is a reference to ValueSet.expansion.property.code.; (xsd)code>
(<valueBoolean:boolean>
|<valueCode:code>
|<valueCoding:Coding>
|<valueDateTime:dateTime>
|<valueDecimal:decimal>
|<valueInteger:integer>
|<valueString:string>)🔗 A parameter that controlled the expansion process. These parameters may be used by users of expanded value sets to check whether the expansion is suitable for a particular purpose, or to pick the correct expansion. The server decides which parameters to include here, but at a minimum, the list SHOULD include all of the parameters that affect the $expand operation. If the expansion will be persisted all of these parameters SHALL be included. If the codeSystem on the server has a specified version then this version SHALL be provided as a parameter in the expansion (note that not all code systems have a version).ValueSet.expansion.parameter(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Name of the input parameter to the $expand operation; may be a server-assigned name for additional default or other server-supplied parameters used to control the expansion process. The names are assigned at the discretion of the server.; (xsd)name:string>
(<valueBoolean:boolean>
|<valueCode:code>
|<valueDateTime:dateTime>
|<valueDecimal:decimal>
|<valueInteger:integer>
|<valueString:string>
|<valueUri:uri>)?🔗 A property defines an additional slot through which additional information can be provided about a concept.ValueSet.expansion.property(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A code that is used to identify the property. The code is used in ValueSet.expansion.contains.property.code.; (xsd)code>
< Reference to the formal meaning of the property. One possible source of meaning is the [Concept Properties](codesystem-concept-properties.html) code system.; (xsd)uri>?🔗 Description of the semantic space the Value Set Expansion is intended to cover and should further clarify the text in ValueSet.description.ValueSet.scope(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Criteria describing which concepts or codes should be included and why.; (xsd)inclusionCriteria:string>?
< Criteria describing which concepts or codes should be excluded and why.; (xsd)exclusionCriteria:string>?🔗 Describes validation requirements, source(s), status and dates for one or more elements.VerificationResult(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< A resource that was validated.; (xsd)target:Resource*>*
[]< The fhirpath location(s) within the resource that was validated.; (xsd)targetLocation:string>*
< The frequency with which the target must be validated (none; initial; periodic). Binding: verificationresult-need (preferred, The frequency with which the target must be validated.); (xsd)need:CodeableConcept>?
< The validation status of the target (attested; validated; in process; requires revalidation; validation failed; revalidation failed). Binding: verificationresult-status (required, The validation status of the target.); (xsd)status:code>
< When the validation status was updated.; (xsd)statusDate:dateTime>?
< What the target is validated against (nothing; primary source; multiple sources). Binding: verificationresult-validation-type (preferred, What the target is validated against.); (xsd)validationType:CodeableConcept>?
[]< The primary process by which the target is validated (edit check; value set; primary source; multiple sources; standalone; in context). Binding: verificationresult-validation-process (example, The primary process by which the target is validated.); (xsd)validationProcess:CodeableConcept>*
< Frequency of revalidation.; (xsd)frequency:Timing>?
< The date/time validation was last completed (including failed validations).; (xsd)lastPerformed:dateTime>?
< The date when target is next validated, if appropriate.; (xsd)nextScheduled:date>?
< The result if validation fails (fatal; warning; record only; none). Binding: verificationresult-failure-action (preferred, The result if validation fails.); (xsd)failureAction:CodeableConcept>?
[]< Information about the primary source(s) involved in validation.; (xsd)primarySource:VerificationResult.primarySource>*
< Information about the entity attesting to information.; (xsd)attestation:VerificationResult.attestation>?
[]< Information about the entity validating information.; (xsd)validator:VerificationResult.validator>*🔗 Information about the entity attesting to information.VerificationResult.attestation(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The individual or organization attesting to information.; (xsd)who:(<Organization>
|<Practitioner>
|<PractitionerRole>)>?
< When the who is asserting on behalf of another (organization or individual).; (xsd)onBehalfOf:(<Organization>
|<Practitioner>
|<PractitionerRole>)>?
< The method by which attested information was submitted/retrieved (manual; API; Push). Binding: verificationresult-communication-method (example, Method for communicating with the data source (manual; API; Push).); (xsd)communicationMethod:CodeableConcept>?
< The date the information was attested to.; (xsd)date>?
< A digital identity certificate associated with the attestation source.; (xsd)sourceIdentityCertificate:string>?
< A digital identity certificate associated with the proxy entity submitting attested information on behalf of the attestation source.; (xsd)proxyIdentityCertificate:string>?
< Signed assertion by the proxy entity indicating that they have the right to submit attested information on behalf of the attestation source.; (xsd)proxySignature:Signature>?
< Signed assertion by the attestation source that they have attested to the information.; (xsd)sourceSignature:Signature>?🔗 Information about the primary source(s) involved in validation.VerificationResult.primarySource(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Reference to the primary source.; (xsd)who:(<Organization>
|<Practitioner>
|<PractitionerRole>)>?
[]< Type of primary source (License Board; Primary Education; Continuing Education; Postal Service; Relationship owner; Registration Authority; legal source; issuing source; authoritative source). Binding: verificationresult-primary-source-type (example, Type of the validation primary source.); (xsd)type:CodeableConcept>*
[]< Method for communicating with the primary source (manual; API; Push). Binding: verificationresult-communication-method (example, Method for communicating with the data source (manual; API; Push).); (xsd)communicationMethod:CodeableConcept>*
< Status of the validation of the target against the primary source (successful; failed; unknown). Binding: verificationresult-validation-status (preferred, Status of the validation of the target against the primary source.); (xsd)validationStatus:CodeableConcept>?
< When the target was validated against the primary source.; (xsd)validationDate:dateTime>?
< Ability of the primary source to push updates/alerts (yes; no; undetermined). Binding: verificationresult-can-push-updates (preferred, Ability of the primary source to push updates/alerts.); (xsd)canPushUpdates:CodeableConcept>?
[]< Type of alerts/updates the primary source can send (specific requested changes; any changes; as defined by source). Binding: verificationresult-push-type-available (preferred, Type of alerts/updates the primary source can send.); (xsd)pushTypeAvailable:CodeableConcept>*🔗 Information about the entity validating information.VerificationResult.validator(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Reference to the organization validating information.; (xsd)organization:Organization*>
< A digital identity certificate associated with the validator.; (xsd)identityCertificate:string>?
< Signed assertion by the validator that they have validated the information.; (xsd)attestationSignature:Signature>?🔗 Virtual Service Contact Details.VirtualServiceDetail(xsd)(doc)=
<#base:DataType>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< The type of virtual service to connect to (i.e. Teams, Zoom, Specific VMR technology, WhatsApp). As this type defines what the virtual service is, it then defines what address and additional information might be relevant.
Some profiles could be used for specific types to define what the other values could/should be. Binding: virtual-service-type (example, The purpose for which an extended contact detail should be used.); (xsd)channelType:Coding>?
< What address or number needs to be used for a user to connect to the virtual service to join. The channelType informs as to which datatype is appropriate to use (requires knowledge of the specific type).; (xsd)address:(<ContactPoint>
|<ExtendedContactDetail>
|<string>
|<url>)>?
[]< Address to see alternative connection details. This web address can be used to provide additional details on the call, such as alternative/regional call in numbers, or other associated services.; (xsd)additionalInfo:url>*
< Maximum number of participants supported by the virtual service. Some services have only a limitted number of participants permitted to connect at a time, this is typically used in "shared" virtual services that you might find on location resources.
Typically on-demand services might not have these restrictions.; (xsd)maxParticipants:positiveInt>?
< Session Key required by the virtual service. Some services require a session key to be able to access the service once connected.
This could be in cases where a shared number is used, and a session key is added to put into a private line, or to identify the participant in a call.; (xsd)sessionKey:string>?🔗 An authorization for the provision of glasses and/or contact lenses to a patient.VisionPrescription(xsd)(doc)=
<#base:DomainResource>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< A unique identifier assigned to this vision prescription.; (xsd)identifier:Identifier>*
< The status of the resource instance. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. Binding: fm-status (required, A code specifying the state of the resource instance.); (xsd)status:code>
< The date this resource was created.; (xsd)created:dateTime>
< A resource reference to the person to whom the vision prescription applies.; (xsd)patient:Patient*>
< A reference to a resource that identifies the particular occurrence of contact between patient and health care provider during which the prescription was issued.; (xsd)encounter:Encounter*>?
< The date (and perhaps time) when the prescription was written. Jurisdictions determine the valid lifetime of a prescription. Typically vision prescriptions are valid for two years from the date written.; (xsd)dateWritten:dateTime>
< The healthcare professional responsible for authorizing the prescription.; (xsd)prescriber:(<Practitioner>
|<PractitionerRole>)>
[]< Contain the details of the individual lens specifications and serves as the authorization for the fullfillment by certified professionals.; (xsd)lensSpecification:VisionPrescription.lensSpecification>+🔗 Contain the details of the individual lens specifications and serves as the authorization for the fullfillment by certified professionals.VisionPrescription.lensSpecification(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Identifies the type of vision correction product which is required for the patient. Binding: vision-product (example, A coded concept describing the vision products.); (xsd)product:CodeableConcept>
< The eye for which the lens specification applies. May also appear on the paper claim form or in the Medical Records as as OD (oculus dexter) for the right eye and OS (oculus sinister) for the left eye. Binding: vision-eye-codes (required, A coded concept listing the eye codes.); (xsd)eye:code>
< Lens power measured in dioptres (0.25 units). The value is negative for near-sighted and positive for far sighted.
Often insurance will not cover a lens with power between +75 and -75.; (xsd)sphere:decimal>?
< Power adjustment for astigmatism measured in dioptres (0.25 units).; (xsd)cylinder:decimal>?
< Adjustment for astigmatism measured in integer degrees. The limits are +180 and -180 degrees.; (xsd)axis:integer>?
[]< Allows for adjustment on two axis.; (xsd)prism:VisionPrescription.lensSpecification.prism>*
< Power adjustment for multifocal lenses measured in dioptres (0.25 units).; (xsd)add:decimal>?
< Contact lens power measured in dioptres (0.25 units).; (xsd)power:decimal>?
< Back curvature measured in millimetres.; (xsd)backCurve:decimal>?
< Contact lens diameter measured in millimetres.; (xsd)diameter:decimal>?
< The recommended maximum wear period for the lens.; (xsd)duration:SimpleQuantity>?
< Special color or pattern.; (xsd)color:string>?
< Brand recommendations or restrictions.; (xsd)brand:string>?
[]< Notes for special requirements such as coatings and lens materials.; (xsd)note:Annotation>*🔗 Allows for adjustment on two axis.VisionPrescription.lensSpecification.prism(xsd)(doc)=
<#base:BackboneElement>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Amount of prism to compensate for eye alignment in fractional units.; (xsd)amount:decimal>
< The relative base, or reference lens edge, for the prism. Binding: vision-base-codes (required, A coded concept listing the base codes.); (xsd)base:code>🔗 The FHIR Vitals Signs profile sets minimum expectations for the Observation Resource to record, search and fetch the vital signs associated with a patient. Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as laboratory reports, etc.vitalsigns(xsd)(doc)=
<#base:Observation>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< A unique identifier assigned to this observation.; (xsd)identifier:Identifier>*
< The reference to a FHIR ObservationDefinition resource that provides the definition that is adhered to in whole or in part by this Observation instance. ObservationDefinition can be referenced by its canonical url using instantiatesCanonical, or by a name or an identifier using the appropriate sub-elements of instantiatesReference.; (xsd)instantiates:ObservationDefinition*>?
[]< A plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed.; (xsd)basedOn:(<CarePlan>
|<DeviceRequest>
|<ImmunizationRecommendation>
|<MedicationRequest>
|<NutritionOrder>
|<ServiceRequest>)>*
[]< Identifies the observation(s) that triggered the performance of this observation.; (xsd)triggeredBy:vitalsigns.triggeredBy>*
[]< A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure. To link an Observation to an Encounter use `encounter`. See the [Notes](observation.html#obsgrouping) below for guidance on referencing another Observation.; (xsd)partOf:(<GenomicStudy>
|<ImagingStudy>
|<Immunization>
|<MedicationAdministration>
|<MedicationDispense>
|<MedicationStatement>
|<Procedure>)>*
< The status of the result value. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. Binding: observation-status (required, ); (xsd)status:code>
[]< A code that classifies the general type of observation being made. In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set. Binding: observation-category (preferred, Codes for high level observation categories.); (xsd)category:CodeableConcept>+
< Coded Responses from C-CDA Vital Sign Results. *All* code-value and, if present, component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. Binding: observation-vitalsignresult (extensible, This identifies the vital sign result type. Original source C-CDA R1.1 , HITSP Vital Sign Result Type.); (xsd)code:CodeableConcept>
< The patient, or group of patients, location, device, organization, procedure or practitioner this observation is about and into whose or what record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the `focus` element or the `code` itself specifies the actual focus of the observation. One would expect this element to be a cardinality of 1..1. The only circumstance in which the subject can be missing is when the observation is made by a device that does not know the patient. In this case, the observation SHALL be matched to a patient through some context/channel matching technique, and at this point, the observation should be updated. The subject of an Observation may in some cases be a procedure. This supports the regulatory inspection use case where observations are captured during inspections of a procedure that is being performed (independent of any particular patient or whether patient related at all).; (xsd)subject:Patient*>
[]< The actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also be an existing condition, an intervention, the subject's diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child's tracheostomy tube. In this example, the child is the patient of record and the mother is the focus. Typically, an observation is made about the subject - a patient, or group of patients, location, or device - and the distinction between the subject and what is directly measured for an observation is specified in the observation code itself ( e.g., "Blood Glucose") and does not need to be represented separately using this element. Use `specimen` if a reference to a specimen is required. If a code is required instead of a resource use either `bodysite` for bodysites or the standard extension [http://hl7.org/fhir/StructureDefinition/observation-focusCode](http://hl7.org/fhir/extensions/StructureDefinition-observation-focusCode.html).; (xsd)focus:Resource*>*
< The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made. This will typically be the encounter the event occurred within, but some events may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission laboratory tests).; (xsd)encounter:Encounter*>?
< Often just a dateTime for Vital Signs. At least a date should be present unless this observation is a historical report. For recording imprecise or "fuzzy" times (For example, a blood glucose measurement taken "after breakfast") use the [Timing](datatypes.html#timing) datatype which allow the measurement to be tied to regular life events.; (xsd)effective:(<dateTime>
|<Period>)>
< The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified. For Observations that don't require review and verification, it may be the same as the [`lastUpdated` ](resource-definitions.html#Meta.lastUpdated) time of the resource itself. For Observations that do require review and verification for certain updates, it might not be the same as the `lastUpdated` time of the resource itself due to a non-clinically significant update that doesn't require the new version to be reviewed and verified again.; (xsd)issued:instant>?
[]< Who was responsible for asserting the observed value as "true".; (xsd)performer:(<CareTeam>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>*
(<valueAttachment:Attachment>
|<valueBoolean:boolean>
|<valueCodeableConcept:CodeableConcept>
|<valueDateTime:dateTime>
|<valueInteger:integer>
|<valueMolecularSequence:MolecularSequence>
|<valuePeriod:Period>
|<valueQuantity:Quantity>
|<valueRange:Range>
|<valueRatio:Ratio>
|<valueSampledData:SampledData>
|<valueString:string>
|<valueTime:time>)?
< Provides a reason why the expected value in the element Observation.value[x] is missing. Null or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be "detected", "not detected", "inconclusive", or "specimen unsatisfactory".
The alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code "error" could be used when the measurement was not completed. Note that an observation may only be reported if there are values to report. For example differential cell counts values may be reported only when > 0. Because of these options, use-case agreements are required to interpret general observations for null or exceptional values. Binding: data-absent-reason (extensible, Codes specifying why the result (`Observation.value[x]`) is missing.); (xsd)dataAbsentReason:CodeableConcept>?
[]< A categorical assessment of an observation value. For example, high, low, normal. Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Binding: observation-interpretation (extensible, Codes identifying interpretations of observations.); (xsd)interpretation:CodeableConcept>*
[]< Comments about the observation or the results. May include general statements about the observation, or statements about significant, unexpected or unreliable results values, or information about its source when relevant to its interpretation.; (xsd)note:Annotation>*
< Indicates the site on the subject's body where the observation was made (i.e. the target site). Only used if not implicit in code found in Observation.code. In many systems, this may be represented as a related observation instead of an inline component. Binding: body-site (example, SNOMED CT Body site concepts); (xsd)bodySite:CodeableConcept>?
< Indicates the body structure on the subject's body where the observation was made (i.e. the target site). Only used if not implicit in code found in Observation.code or bodySite is used. In many systems, this may be represented as a related observation instead of an inline component.; (xsd)bodyStructure:BodyStructure*>?
< Indicates the mechanism used to perform the observation. Only used if not implicit in code for Observation.code. Binding: observation-methods (example, Methods for simple observations.); (xsd)method:CodeableConcept>?
< The specimen that was used when this observation was made. Should only be used if not implicit in code found in `Observation.code`. Observations are not made on specimens themselves; they are made on a subject, but in many cases by the means of a specimen. Note that although specimens are often involved, they are not always tracked and reported explicitly. Also note that observation resources may be used in contexts that track the specimen explicitly (e.g. Diagnostic Report).; (xsd)specimen:(<Group>
|<Specimen>)>?
< A reference to the device that generates the measurements or the device settings for the device. Note that this is not meant to represent a device involved in the transmission of the result, e.g., a gateway. Such devices may be documented using the Provenance resource where relevant.; (xsd)device:(<Device>
|<DeviceMetric>)>?
[]< Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an "OR". In other words, to represent two distinct target populations, two `referenceRange` elements would be used. Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.; (xsd)referenceRange:vitalsigns.referenceRange>*
[]< Used when reporting vital signs panel components. When using this element, an observation will typically have either a value or a set of related resources, although both may be present in some cases. For a discussion on the ways Observations can assembled in groups together, see [Notes](observation.html#obsgrouping) below. Note that a system may calculate results from [QuestionnaireResponse](questionnaireresponse.html) into a final score and represent the score as an Observation.; (xsd)hasMember:(<MolecularSequence>
|<QuestionnaireResponse>
|<vitalsigns>)>*
[]< The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image. All the reference choices that are listed in this element can represent clinical observations and other measurements that may be the source for a derived value. The most common reference will be another Observation. For a discussion on the ways Observations can assembled in groups together, see [Notes](observation.html#obsgrouping) below.; (xsd)derivedFrom:(<DocumentReference>
|<ImagingStudy>
|<MolecularSequence>
|<QuestionnaireResponse>
|<vitalsigns>)>*
[]< Used when reporting systolic and diastolic blood pressure. For a discussion on the ways Observations can be assembled in groups together see [Notes](observation.html#notes) below.; (xsd)component:vitalsigns.component>*
< A code that classifies the general type of observation being made. In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set. Binding: observation-category (preferred, Codes for high level observation categories.); (xsd)VSCat:vitalsigns.VSCat>🔗 Used when reporting systolic and diastolic blood pressure. For a discussion on the ways Observations can be assembled in groups together see [Notes](observation.html#notes) below.vitalsigns.component(xsd)(doc)=
<#base:Observation.component>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Describes what was observed. Sometimes this is called the observation "code". *All* code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. Binding: observation-vitalsignresult (extensible, This identifies the vital sign result type. Original source C-CDA R1.1 , HITSP Vital Sign Result Type.); (xsd)code:CodeableConcept>
(<valueAttachment:Attachment>
|<valueBoolean:boolean>
|<valueCodeableConcept:CodeableConcept>
|<valueDateTime:dateTime>
|<valueInteger:integer>
|<valueMolecularSequence:MolecularSequence>
|<valuePeriod:Period>
|<valueQuantity:Quantity>
|<valueRange:Range>
|<valueRatio:Ratio>
|<valueSampledData:SampledData>
|<valueString:string>
|<valueTime:time>)?
< Provides a reason why the expected value in the element Observation.component.value[x] is missing. "Null" or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be "detected", "not detected", "inconclusive", or "test not done".
The alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code "error" could be used when the measurement was not completed. Because of these options, use-case agreements are required to interpret general observations for exceptional values. Binding: data-absent-reason (extensible, Codes specifying why the result (`Observation.value[x]`) is missing.); (xsd)dataAbsentReason:CodeableConcept>?
[]< A categorical assessment of an observation value. For example, high, low, normal. Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Binding: observation-interpretation (extensible, Codes identifying interpretations of observations.); (xsd)interpretation:CodeableConcept>*
[]< Guidance on how to interpret the value by comparison to a normal or recommended range. Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.; (xsd)referenceRange:Observation.referenceRange>*
< Vital Sign Value recorded with UCUM. Used when observation has a set of component observations:
- An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was derived).
- If a value is present, the datatype for this element should be determined by the `code`.
- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.
- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.
- If a value is present, the datatype for this element should be determined by the `code`.
- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.
- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.
- The usage of valueReference is restricted to the MolecularSequence resource when used as a definitional resource, not as a patient-specific finding. .
- For additional guidance, see the [Notes section](observation.html#notes) below. Binding: ucum-vitals-common (required, Commonly encountered UCUM units for recording Vital Signs.); (xsd)valueQuantity:Quantity>?🔗 Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an "OR". In other words, to represent two distinct target populations, two `referenceRange` elements would be used. Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.vitalsigns.referenceRange(xsd)(doc)=
<#base:Observation.referenceRange>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The value of the low bound of the reference range. The low bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the low bound is omitted, it is assumed to be meaningless (e.g. reference range is <=2.3).; (xsd)low:SimpleQuantity>?
< The value of the high bound of the reference range. The high bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the high bound is omitted, it is assumed to be meaningless (e.g. reference range is >= 2.3).; (xsd)high:SimpleQuantity>?
< The value of the normal value of the reference range. Binding: observation-referencerange-normalvalue (extensible, Codes identifying the normal value of the observation.); (xsd)normalValue:CodeableConcept>?
< Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range. This SHOULD be populated if there is more than one range. If this element is not present then the normal range is assumed. Binding: referencerange-meaning (preferred, Code for the meaning of a reference range.); (xsd)type:CodeableConcept>?
[]< Codes to indicate the target population this reference range applies to. For example, a reference range may be based on the normal population or a particular sex or race. Multiple `appliesTo` are interpreted as an "AND" of the target populations. For example, to represent a target population of African American females, both a code of female and a code for African American would be used. This SHOULD be populated if there is more than one range. If this element is not present then the normal population is assumed. Binding: referencerange-appliesto (example, Codes identifying the population the reference range applies to.); (xsd)appliesTo:CodeableConcept>*
< The age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so.; (xsd)age:Range>?
< Text based reference range in an observation which may be used when a quantitative range is not appropriate for an observation. An example would be a reference value of "Negative" or a list or table of "normals".; (xsd)text:markdown>?🔗 Identifies the observation(s) that triggered the performance of this observation.vitalsigns.triggeredBy(xsd)(doc)=
<#base:Observation.triggeredBy>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Reference to the triggering observation.; (xsd)observation:Observation*>
< The type of trigger.
Reflex | Repeat | Re-run. Binding: observation-triggeredbytype (required, The type of TriggeredBy Observation.); (xsd)type:code>
< Provides the reason why this observation was performed as a result of the observation(s) referenced.; (xsd)reason:string>?🔗 A code that classifies the general type of observation being made. In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set. Binding: observation-category (preferred, Codes for high level observation categories.)vitalsigns.VSCat(xsd)(doc)=
<#base:CodeableConcept>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< 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.; (xsd)coding:vitalsigns.VSCat.coding>+
< 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.; (xsd)text:string>?🔗 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.vitalsigns.VSCat.coding(xsd)(doc)=
<#base:Coding>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< 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 be an absolute reference to some definition that establishes the system clearly and unambiguously. http://terminology.hl7.org/CodeSystem/observation-category; (xsd)system:uri>
< 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.; (xsd)version:string>?
< 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). vital-signs; (xsd)code>
< A representation of the meaning of the code in the system, following the rules of the system.; (xsd)display:string>?
< 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.; (xsd)userSelected:boolean>?🔗 This profile defines the top-level grouping structure for a set of vital signs. It has no value in Observation.valueQuantity ; instead, it just includes related links (with type=has-member) to the Observations in this set (e.g. respiratory rate, heart rate, BP). Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as laboratory reports, etc.vitalspanel(xsd)(doc)=
<#base:vitalsigns>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< A unique identifier assigned to this observation.; (xsd)identifier:Identifier>*
< The reference to a FHIR ObservationDefinition resource that provides the definition that is adhered to in whole or in part by this Observation instance. ObservationDefinition can be referenced by its canonical url using instantiatesCanonical, or by a name or an identifier using the appropriate sub-elements of instantiatesReference.; (xsd)instantiates:ObservationDefinition*>?
[]< A plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed.; (xsd)basedOn:(<CarePlan>
|<DeviceRequest>
|<ImmunizationRecommendation>
|<MedicationRequest>
|<NutritionOrder>
|<ServiceRequest>)>*
[]< Identifies the observation(s) that triggered the performance of this observation.; (xsd)triggeredBy:vitalspanel.triggeredBy>*
[]< A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure. To link an Observation to an Encounter use `encounter`. See the [Notes](observation.html#obsgrouping) below for guidance on referencing another Observation.; (xsd)partOf:(<GenomicStudy>
|<ImagingStudy>
|<Immunization>
|<MedicationAdministration>
|<MedicationDispense>
|<MedicationStatement>
|<Procedure>)>*
< The status of the result value. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. Binding: observation-status (required, ); (xsd)status:code>
[]< A code that classifies the general type of observation being made. In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set. Binding: observation-category (preferred, Codes for high level observation categories.); (xsd)category:CodeableConcept>+
< Vital Signs Panel. additional codes that translate or map to this code are allowed. For example a more granular LOINC code or code that is used locally in a system. Binding: observation-vitalsignresult (extensible, This identifies the vital sign result type. Original source C-CDA R1.1 , HITSP Vital Sign Result Type.); (xsd)code:vitalspanel.code>
< The patient, or group of patients, location, device, organization, procedure or practitioner this observation is about and into whose or what record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the `focus` element or the `code` itself specifies the actual focus of the observation. One would expect this element to be a cardinality of 1..1. The only circumstance in which the subject can be missing is when the observation is made by a device that does not know the patient. In this case, the observation SHALL be matched to a patient through some context/channel matching technique, and at this point, the observation should be updated. The subject of an Observation may in some cases be a procedure. This supports the regulatory inspection use case where observations are captured during inspections of a procedure that is being performed (independent of any particular patient or whether patient related at all).; (xsd)subject:Patient*>
[]< The actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also be an existing condition, an intervention, the subject's diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child's tracheostomy tube. In this example, the child is the patient of record and the mother is the focus. Typically, an observation is made about the subject - a patient, or group of patients, location, or device - and the distinction between the subject and what is directly measured for an observation is specified in the observation code itself ( e.g., "Blood Glucose") and does not need to be represented separately using this element. Use `specimen` if a reference to a specimen is required. If a code is required instead of a resource use either `bodysite` for bodysites or the standard extension [http://hl7.org/fhir/StructureDefinition/observation-focusCode](http://hl7.org/fhir/extensions/StructureDefinition-observation-focusCode.html).; (xsd)focus:Resource*>*
< The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made. This will typically be the encounter the event occurred within, but some events may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission laboratory tests).; (xsd)encounter:Encounter*>?
< Often just a dateTime for Vital Signs. At least a date should be present unless this observation is a historical report. For recording imprecise or "fuzzy" times (For example, a blood glucose measurement taken "after breakfast") use the [Timing](datatypes.html#timing) datatype which allow the measurement to be tied to regular life events.; (xsd)effective:(<dateTime>
|<Period>)>
< The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified. For Observations that don't require review and verification, it may be the same as the [`lastUpdated` ](resource-definitions.html#Meta.lastUpdated) time of the resource itself. For Observations that do require review and verification for certain updates, it might not be the same as the `lastUpdated` time of the resource itself due to a non-clinically significant update that doesn't require the new version to be reviewed and verified again.; (xsd)issued:instant>?
[]< Who was responsible for asserting the observed value as "true".; (xsd)performer:(<CareTeam>
|<Organization>
|<Patient>
|<Practitioner>
|<PractitionerRole>
|<RelatedPerson>)>*
(<valueAttachment:Attachment>
|<valueBoolean:boolean>
|<valueCodeableConcept:CodeableConcept>
|<valueDateTime:dateTime>
|<valueInteger:integer>
|<valueMolecularSequence:MolecularSequence>
|<valuePeriod:Period>
|<valueQuantity:Quantity>
|<valueRange:Range>
|<valueRatio:Ratio>
|<valueSampledData:SampledData>
|<valueString:string>
|<valueTime:time>){0,0}
< Provides a reason why the expected value in the element Observation.value[x] is missing. Null or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be "detected", "not detected", "inconclusive", or "specimen unsatisfactory".
The alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code "error" could be used when the measurement was not completed. Note that an observation may only be reported if there are values to report. For example differential cell counts values may be reported only when > 0. Because of these options, use-case agreements are required to interpret general observations for null or exceptional values. Binding: data-absent-reason (extensible, Codes specifying why the result (`Observation.value[x]`) is missing.); (xsd)dataAbsentReason:CodeableConcept>?
[]< A categorical assessment of an observation value. For example, high, low, normal. Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Binding: observation-interpretation (extensible, Codes identifying interpretations of observations.); (xsd)interpretation:CodeableConcept>*
[]< Comments about the observation or the results. May include general statements about the observation, or statements about significant, unexpected or unreliable results values, or information about its source when relevant to its interpretation.; (xsd)note:Annotation>*
< Indicates the site on the subject's body where the observation was made (i.e. the target site). Only used if not implicit in code found in Observation.code. In many systems, this may be represented as a related observation instead of an inline component. Binding: body-site (example, SNOMED CT Body site concepts); (xsd)bodySite:CodeableConcept>?
< Indicates the body structure on the subject's body where the observation was made (i.e. the target site). Only used if not implicit in code found in Observation.code or bodySite is used. In many systems, this may be represented as a related observation instead of an inline component.; (xsd)bodyStructure:BodyStructure*>?
< Indicates the mechanism used to perform the observation. Only used if not implicit in code for Observation.code. Binding: observation-methods (example, Methods for simple observations.); (xsd)method:CodeableConcept>?
< The specimen that was used when this observation was made. Should only be used if not implicit in code found in `Observation.code`. Observations are not made on specimens themselves; they are made on a subject, but in many cases by the means of a specimen. Note that although specimens are often involved, they are not always tracked and reported explicitly. Also note that observation resources may be used in contexts that track the specimen explicitly (e.g. Diagnostic Report).; (xsd)specimen:(<Group>
|<Specimen>)>?
< A reference to the device that generates the measurements or the device settings for the device. Note that this is not meant to represent a device involved in the transmission of the result, e.g., a gateway. Such devices may be documented using the Provenance resource where relevant.; (xsd)device:(<Device>
|<DeviceMetric>)>?
[]< Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an "OR". In other words, to represent two distinct target populations, two `referenceRange` elements would be used. Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.; (xsd)referenceRange:vitalspanel.referenceRange>*
[]< Used when reporting vital signs panel components. When using this element, an observation will typically have either a value or a set of related resources, although both may be present in some cases. For a discussion on the ways Observations can assembled in groups together, see [Notes](observation.html#obsgrouping) below. Note that a system may calculate results from [QuestionnaireResponse](questionnaireresponse.html) into a final score and represent the score as an Observation.; (xsd)hasMember:(<MolecularSequence>
|<QuestionnaireResponse>
|<vitalsigns>)>+
[]< The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image. All the reference choices that are listed in this element can represent clinical observations and other measurements that may be the source for a derived value. The most common reference will be another Observation. For a discussion on the ways Observations can assembled in groups together, see [Notes](observation.html#obsgrouping) below.; (xsd)derivedFrom:(<DocumentReference>
|<ImagingStudy>
|<MolecularSequence>
|<QuestionnaireResponse>
|<vitalsigns>)>*
[]< Used when reporting systolic and diastolic blood pressure. For a discussion on the ways Observations can be assembled in groups together see [Notes](observation.html#notes) below.; (xsd)component:vitalspanel.component>*
< A code that classifies the general type of observation being made. In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set. Binding: observation-category (preferred, Codes for high level observation categories.); (xsd)VSCat:vitalspanel.VSCat>🔗 Vital Signs Panel. additional codes that translate or map to this code are allowed. For example a more granular LOINC code or code that is used locally in a system. Binding: observation-vitalsignresult (extensible, This identifies the vital sign result type. Original source C-CDA R1.1 , HITSP Vital Sign Result Type.)vitalspanel.code(xsd)(doc)=
<#base:CodeableConcept>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< 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.; (xsd)coding:Coding>*
< 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.; (xsd)text:string>?
[]< 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.; (xsd)VitalsPanelCode:vitalspanel.code.VitalsPanelCode>*🔗 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.vitalspanel.code.VitalsPanelCode(xsd)(doc)=
<#base:Coding>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< 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 be an absolute reference to some definition that establishes the system clearly and unambiguously. http://loinc.org; (xsd)system:uri>?
< 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.; (xsd)version:string>?
< 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). 85353-1; (xsd)code>?
< A representation of the meaning of the code in the system, following the rules of the system.; (xsd)display:string>?
< 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.; (xsd)userSelected:boolean>?🔗 Used when reporting systolic and diastolic blood pressure. For a discussion on the ways Observations can be assembled in groups together see [Notes](observation.html#notes) below.vitalspanel.component(xsd)(doc)=
<#base:Observation.component>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Describes what was observed. Sometimes this is called the observation "code". *All* code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. Binding: observation-vitalsignresult (extensible, This identifies the vital sign result type. Original source C-CDA R1.1 , HITSP Vital Sign Result Type.); (xsd)code:CodeableConcept>
(<valueAttachment:Attachment>
|<valueBoolean:boolean>
|<valueCodeableConcept:CodeableConcept>
|<valueDateTime:dateTime>
|<valueInteger:integer>
|<valueMolecularSequence:MolecularSequence>
|<valuePeriod:Period>
|<valueQuantity:Quantity>
|<valueRange:Range>
|<valueRatio:Ratio>
|<valueSampledData:SampledData>
|<valueString:string>
|<valueTime:time>)?
< Provides a reason why the expected value in the element Observation.component.value[x] is missing. "Null" or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be "detected", "not detected", "inconclusive", or "test not done".
The alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code "error" could be used when the measurement was not completed. Because of these options, use-case agreements are required to interpret general observations for exceptional values. Binding: data-absent-reason (extensible, Codes specifying why the result (`Observation.value[x]`) is missing.); (xsd)dataAbsentReason:CodeableConcept>?
[]< A categorical assessment of an observation value. For example, high, low, normal. Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Binding: observation-interpretation (extensible, Codes identifying interpretations of observations.); (xsd)interpretation:CodeableConcept>*
[]< Guidance on how to interpret the value by comparison to a normal or recommended range. Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.; (xsd)referenceRange:Observation.referenceRange>*
< Vital Sign Value recorded with UCUM. Used when observation has a set of component observations:
- An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was derived).
- If a value is present, the datatype for this element should be determined by the `code`.
- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.
- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.
- If a value is present, the datatype for this element should be determined by the `code`.
- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.
- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.
- The usage of valueReference is restricted to the MolecularSequence resource when used as a definitional resource, not as a patient-specific finding. .
- For additional guidance, see the [Notes section](observation.html#notes) below. Binding: ucum-vitals-common (required, Commonly encountered UCUM units for recording Vital Signs.); (xsd)valueQuantity:Quantity>?🔗 Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an "OR". In other words, to represent two distinct target populations, two `referenceRange` elements would be used. Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.vitalspanel.referenceRange(xsd)(doc)=
<#base:Observation.referenceRange>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The value of the low bound of the reference range. The low bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the low bound is omitted, it is assumed to be meaningless (e.g. reference range is <=2.3).; (xsd)low:SimpleQuantity>?
< The value of the high bound of the reference range. The high bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the high bound is omitted, it is assumed to be meaningless (e.g. reference range is >= 2.3).; (xsd)high:SimpleQuantity>?
< The value of the normal value of the reference range. Binding: observation-referencerange-normalvalue (extensible, Codes identifying the normal value of the observation.); (xsd)normalValue:CodeableConcept>?
< Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range. This SHOULD be populated if there is more than one range. If this element is not present then the normal range is assumed. Binding: referencerange-meaning (preferred, Code for the meaning of a reference range.); (xsd)type:CodeableConcept>?
[]< Codes to indicate the target population this reference range applies to. For example, a reference range may be based on the normal population or a particular sex or race. Multiple `appliesTo` are interpreted as an "AND" of the target populations. For example, to represent a target population of African American females, both a code of female and a code for African American would be used. This SHOULD be populated if there is more than one range. If this element is not present then the normal population is assumed. Binding: referencerange-appliesto (example, Codes identifying the population the reference range applies to.); (xsd)appliesTo:CodeableConcept>*
< The age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so.; (xsd)age:Range>?
< Text based reference range in an observation which may be used when a quantitative range is not appropriate for an observation. An example would be a reference value of "Negative" or a list or table of "normals".; (xsd)text:markdown>?🔗 Identifies the observation(s) that triggered the performance of this observation.vitalspanel.triggeredBy(xsd)(doc)=
<#base:Observation.triggeredBy>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< Reference to the triggering observation.; (xsd)observation:Observation*>
< The type of trigger.
Reflex | Repeat | Re-run. Binding: observation-triggeredbytype (required, The type of TriggeredBy Observation.); (xsd)type:code>
< Provides the reason why this observation was performed as a result of the observation(s) referenced.; (xsd)reason:string>?🔗 A code that classifies the general type of observation being made. In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set. Binding: observation-category (preferred, Codes for high level observation categories.)vitalspanel.VSCat(xsd)(doc)=
<#base:vitalsigns.VSCat>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< 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.; (xsd)coding:vitalspanel.VSCat.coding>+
< 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.; (xsd)text:string>?🔗 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.vitalspanel.VSCat.coding(xsd)(doc)=
<#base:vitalsigns.VSCat.coding>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
< 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 be an absolute reference to some definition that establishes the system clearly and unambiguously. http://terminology.hl7.org/CodeSystem/observation-category; (xsd)system:uri>
< 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.; (xsd)version:string>?
< 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). vital-signs; (xsd)code>
< A representation of the meaning of the code in the system, following the rules of the system.; (xsd)display:string>?
< 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.; (xsd)userSelected:boolean>?🔗 A single issue - either an indication, contraindication, interaction or an undesirable effect for a medicinal product, medication, device or procedure.WarningDefinition(xsd)(doc)=
<#base:ClinicalUseDefinition>
< The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.; (xsd)id:string>?
< 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.; (xsd)meta:Meta>?
< 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.; (xsd)implicitRules:uri>?
< The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Binding: all-languages (required, IETF language tag for a human language); (xsd)language:code>?
< 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. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.; (xsd)text:Narrative>?
[]< These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.; (xsd)contained:Resource>*
[]< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension: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 managable, 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). 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.; (xsd)modifierExtension:Extension>*
[]< Business identifier for this issue.; (xsd)identifier:Identifier>*
< indication | contraindication | interaction | undesirable-effect | warning. Binding: clinical-use-definition-type (required, Overall defining type of this clinical use definition.) warning; (xsd)type:code>
[]< A categorisation of the issue, primarily for dividing warnings into subject heading areas such as "Pregnancy and Lactation", "Overdose", "Effects on Ability to Drive and Use Machines". Binding: clinical-use-definition-category (preferred, A categorisation for a clinical use information item.); (xsd)category:CodeableConcept>*
[]< The medication, product, substance, device, procedure etc. for which this is an indication.; (xsd)subject:(<ActivityDefinition>
|<BiologicallyDerivedProduct>
|<Device>
|<DeviceDefinition>
|<Medication>
|<MedicinalProductDefinition>
|<NutritionProduct>
|<PlanDefinition>
|<Substance>)>*
< Whether this is a current issue or one that has been retired etc. Binding: publication-status (preferred, The lifecycle status of an artifact.); (xsd)status:CodeableConcept>?
< Specifics for when this is a contraindication.; (xsd)contraindication:WarningDefinition.contraindication>{0,0}
< Specifics for when this is an indication.; (xsd)indication:WarningDefinition.indication>{0,0}
< Specifics for when this is an interaction.; (xsd)interaction:WarningDefinition.interaction>{0,0}
[]< The population group to which this applies.; (xsd)population:Group*>*
[]< Logic used by the clinical use definition.; (xsd)library:Library*>*
< Describe the possible undesirable effects (negative outcomes) from the use of the medicinal product as treatment.; (xsd)undesirableEffect:WarningDefinition.undesirableEffect>{0,0}
< A critical piece of information about environmental, health or physical risks or hazards that serve as caution to the user. For example 'Do not operate heavy machinery', 'May cause drowsiness', or 'Get medical advice/attention if you feel unwell'.; (xsd)warning:WarningDefinition.warning>🔗 Specifics for when this is a contraindication.WarningDefinition.contraindication(xsd)(doc)=
<#base:ClinicalUseDefinition.contraindication>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The situation that is being documented as contraindicating against this item. Binding: disease-symptom-procedure (example, A symptom, disease or procedure.); (xsd)diseaseSymptomProcedure:ObservationDefinition*>?
< The status of the disease or symptom for the contraindication, for example "chronic" or "metastatic". Binding: disease-status (example, The status of a disease or symptom.); (xsd)diseaseStatus:ObservationDefinition*>?
[]< A comorbidity (concurrent condition) or coinfection. Binding: disease-symptom-procedure (example, A symptom, disease or procedure.); (xsd)comorbidity:ObservationDefinition*>*
[]< The indication which this is a contraidication for.; (xsd)indication:ClinicalUseDefinition*>*
< An expression that returns true or false, indicating whether the indication is applicable or not, after having applied its other elements. The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.; (xsd)applicability:Expression>?
[]< Information about the use of the medicinal product in relation to other therapies described as part of the contraindication.; (xsd)otherTherapy:WarningDefinition.contraindication.otherTherapy>*🔗 Information about the use of the medicinal product in relation to other therapies described as part of the contraindication.WarningDefinition.contraindication.otherTherapy(xsd)(doc)=
<#base:ClinicalUseDefinition.contraindication.otherTherapy>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The type of relationship between the medicinal product indication or contraindication and another therapy. Binding: therapy-relationship-type (preferred, Classification of relationship between a therapy and a contraindication or an indication.); (xsd)relationshipType:CodeableConcept>
< Reference to a specific medication (active substance, medicinal product or class of products, biological, food etc.) as part of an indication or contraindication. Binding: therapy (example, A therapy.); (xsd)treatment:(<ActivityDefinition>
|<BiologicallyDerivedProduct>
|<Medication>
|<MedicinalProductDefinition>
|<NutritionProduct>
|<Substance>
|<SubstanceDefinition>)>🔗 Specifics for when this is an indication.WarningDefinition.indication(xsd)(doc)=
<#base:ClinicalUseDefinition.indication>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The situation that is being documented as an indicaton for this item. Binding: disease-symptom-procedure (example, A symptom, disease or procedure.); (xsd)diseaseSymptomProcedure:ObservationDefinition*>?
< The status of the disease or symptom for the indication, for example "chronic" or "metastatic". Binding: disease-status (example, The status of a disease or symptom.); (xsd)diseaseStatus:ObservationDefinition*>?
[]< A comorbidity (concurrent condition) or coinfection as part of the indication. Binding: disease-symptom-procedure (example, A symptom, disease or procedure.); (xsd)comorbidity:ObservationDefinition*>*
< The intended effect, aim or strategy to be achieved. Binding: product-intended-use (preferred, The overall intended use of a product.); (xsd)intendedEffect:ObservationDefinition*>?
< Timing or duration information, that may be associated with use with the indicated condition e.g. Adult patients suffering from myocardial infarction (from a few days until less than 35 days), ischaemic stroke (from 7 days until less than 6 months).; (xsd)duration:(<Range>
|<string>)>?
[]< An unwanted side effect or negative outcome that may happen if you use the drug (or other subject of this resource) for this indication.; (xsd)undesirableEffect:ClinicalUseDefinition*>*
< An expression that returns true or false, indicating whether the indication is applicable or not, after having applied its other elements. The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.; (xsd)applicability:Expression>?
[]< Information about the use of the medicinal product in relation to other therapies described as part of the indication.; (xsd)otherTherapy:ClinicalUseDefinition.contraindication.otherTherapy>*🔗 Specifics for when this is an interaction.WarningDefinition.interaction(xsd)(doc)=
<#base:ClinicalUseDefinition.interaction>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
[]< The specific medication, product, food, substance etc. or laboratory test that interacts.; (xsd)interactant:WarningDefinition.interaction.interactant>*
< The type of the interaction e.g. drug-drug interaction, drug-food interaction, drug-lab test interaction. Binding: interaction-type (example, A categorisation for an interaction between two substances.); (xsd)type:CodeableConcept>?
< The effect of the interaction, for example "reduced gastric absorption of primary medication". Binding: interaction-effect (example, A interaction effect of clinical use of a medication or other substance.); (xsd)effect:ObservationDefinition*>?
< The incidence of the interaction, e.g. theoretical, observed. Binding: interaction-incidence (example, A categorisation for incidence of occurence of an interaction.); (xsd)incidence:CodeableConcept>?
[]< Actions for managing the interaction. Binding: interaction-management (example, A type of management for an interaction of a medication or other substance.); (xsd)management:CodeableConcept>*🔗 The specific medication, product, food, substance etc. or laboratory test that interacts.WarningDefinition.interaction.interactant(xsd)(doc)=
<#base:ClinicalUseDefinition.interaction.interactant>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The specific medication, product, food, substance etc. or laboratory test that interacts. Binding: interactant (example, An interactant - a substance that may have a clinically significant effect on another.); (xsd)item:(<BiologicallyDerivedProduct>
|<CodeableConcept>
|<Medication>
|<MedicinalProductDefinition>
|<NutritionProduct>
|<ObservationDefinition>
|<Substance>)>🔗 Describe the possible undesirable effects (negative outcomes) from the use of the medicinal product as treatment.WarningDefinition.undesirableEffect(xsd)(doc)=
<#base:ClinicalUseDefinition.undesirableEffect>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< The situation in which the undesirable effect may manifest. Binding: undesirable-effect-symptom (example, An undesirable effect of clinical use.); (xsd)symptomConditionEffect:ObservationDefinition*>?
< High level classification of the effect. Binding: undesirable-effect-classification (example, A categorisation for an undesirable effect.); (xsd)classification:CodeableConcept>?
< How often the effect is seen. Binding: undesirable-effect-frequency (example, A categorisation for a frequency of occurence of an undesirable effect.); (xsd)frequencyOfOccurrence:CodeableConcept>?🔗 A critical piece of information about environmental, health or physical risks or hazards that serve as caution to the user. For example 'Do not operate heavy machinery', 'May cause drowsiness', or 'Get medical advice/attention if you feel unwell'.WarningDefinition.warning(xsd)(doc)=
<#base:ClinicalUseDefinition.warning>
< Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.; (xsd)id:string>?
[]< May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>*
[]< May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
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.; (xsd)modifierExtension:Extension>*
< A textual definition of this warning, with formatting.; (xsd)description:markdown>?
< A coded or unformatted textual definition of this warning. Binding: warning-type (example, Classification of warning type.); (xsd)code:CodeableConcept>?🔗 XHTMLxhtml(xsd)(doc)=
<#base:Element>
< unique id for the element within a resource (for internal references); (xsd)id:string>?
< 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.; (xsd)extension:Extension>{0,0}
< Actual xhtml; (xsd)value:string>